# Pixi’VN - PixiJS Game Engine (/pixi-vn)



![pixi-vn-cover](https://github.com/user-attachments/assets/9bd54406-f41a-4d2c-959c-96a773a6103c)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/pixi-vn" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/pixi-vn?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/pixi-vn" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

Pixi’VN is a very versatile and powerful story-driven engine. It is based on JavaScript/TypeScript and [PixiJS](https://pixijs.com/), and supports animated characters through [Spine 2D](https://esotericsoftware.com/) and [Live2D](https://www.live2d.com/).

Pixi’VN aims to be an innovative and fast engine, and puts a strong emphasis on AI-assisted development: an AI agent can start your game, gain all the knowledge it needs about your project through [Agent Skills](#agent-skills), and test the game by launching it in a browser — with the ability to keep driving it from the outside while it plays.

You can use narrative languages that are able to take full advantage of the engine's features, as well as any custom features you add to your project. Currently supported:

* [*ink*](https://pixi-vn.com/ink/ink)

## Templates [#templates]

For a quick start, various project templates are available, built with React. Less experienced developers can use these templates without much knowledge of JavaScript/TypeScript.

* **[Visual Novel](https://pixi-vn.com/start/make-visual-novel)**: a classic dialogue-driven experience, with characters, backgrounds, and choices.
* **[Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)**: an adventure game where the player explores scenes and interacts with objects and characters.
* **[Interactive Fiction](https://pixi-vn.com/start/make-interactive-fiction)**: feels like reading a book. Unlike a visual novel, images are shown as vignettes, just as illustrations would appear on a page.

To create a new project from a template, run:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm create pixi-vn@latest
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm create pixi-vn
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn create pixi-vn
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bunx create-pixi-vn
    ```
  </CodeBlockTab>
</CodeBlockTabs>

### Distribution [#distribution]

Pixi’VN is independent of any distribution technology, but strong emphasis is being placed on [Roves](https://roves.pixi-vn.com/), built by the same team behind Pixi’VN.

| Platform    | [Roves](https://roves.pixi-vn.com/) | [Tauri](https://v2.tauri.app/) | [Electron](https://www.electronjs.org/) |
| ----------- | ----------------------------------- | ------------------------------ | --------------------------------------- |
| Windows     | ✅                                   | ✅                              | ✅                                       |
| macOS       | ✅                                   | ✅                              | ✅                                       |
| Linux       | ✅                                   | ✅                              | ✅                                       |
| Android     | ✅                                   | ✅                              | ❌                                       |
| iOS         | 🚧                                  | ✅                              | ❌                                       |
| Nintendo    | 🚧                                  | ❌                              | ❌                                       |
| PlayStation | 🚧                                  | ❌                              | ❌                                       |
| Xbox        | 🚧                                  | ❌                              | ❌                                       |

## Wiki [#wiki]

* [Quick Start](https://pixi-vn.com/start/getting-started)
  * [Templates](https://pixi-vn.com/start/templates)
* Features:
  * [Characters](https://pixi-vn.com/start/character)
  * [Narration](https://pixi-vn.com/start/narration)
  * [Assets](https://pixi-vn.com/start/assets)
  * [Canvas WebGL/WebGPU](https://pixi-vn.com/start/canvas)
  * [Sounds and music](https://pixi-vn.com/start/sound)
  * [Storage](https://pixi-vn.com/start/storage)
  * [User Interface (UI)](https://pixi-vn.com/start/interface)
  * [Minigames](https://pixi-vn.com/start/minigames)
  * [AI-Generated Content](https://pixi-vn.com/start/ai-generated-content)
  * [Save and load](https://pixi-vn.com/start/save)
  * [Distribution](https://pixi-vn.com/start/distribution)

## Prerequisites [#prerequisites]

Before starting, you must have the following tools installed:

* [Node.js](https://nodejs.org/) version 18 or higher.
* Text editor with TypeScript support, such as:
  * [Visual Studio Code](https://code.visualstudio.com/)
  * [Cursor](https://www.cursor.com/)
  * [VSCodium](https://vscodium.com/)

## Installation [#installation]

To install the Pixi’VN package in an existing JavaScript project, use one of the following commands:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @drincs/pixi-vn
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @drincs/pixi-vn
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @drincs/pixi-vn
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @drincs/pixi-vn
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Initialize [#initialize]

Before using the Pixi’VN engine, you must initialize the game. You can do this by calling the `Game.init` method.

```ts title="src/main.tsx"
import { Game } from "@drincs/pixi-vn";

const body = document.body;
if (!body) {
  throw new Error("body element not found");
}

Game.init(body, {
  height: 1080,
  width: 1920,
  backgroundColor: "#303030",
}).then(() => {
  // ...
  Game.start("start", {});
});

// read more here: https://pixi-vn.com/start/other-narrative-features.html#how-manage-the-end-of-the-game
Game.onEnd(async (props) => {
  Game.clear();
  // navigate to main menu
});

Game.addOnError((error, props) => {
  console.error(`Error occurred`, error);
});

Game.onNavigate((path) => navigateTo(path));
```

```html title="index.html"
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Game</title>
  </head>
  <body>
    <div id="root"></div>
    <script type="module" src="/src/main.ts"></script>
  </body>
</html>
```

```css title="styles.css"
html,
body {
  background-color: #242424;
  height: 100%;
}

body {
  margin: 0;
  min-height: 100vh;
  display: flex;
  overflow: hidden;
}
```

## Agent Skills [#agent-skills]

Pixi'VN ships a set of [Agent Skills](https://www.skills.sh/) that teach AI coding assistants (like Claude Code) how to correctly use each part of the engine. If you use Claude Code, you can install all of them into your project with:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npx skills add DRincs-Productions/pixi-vn --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm dlx skills add DRincs-Productions/pixi-vn --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn dlx skills add DRincs-Productions/pixi-vn --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun x skills add DRincs-Productions/pixi-vn --all
    ```
  </CodeBlockTab>
</CodeBlockTabs>

This installs every skill below and prompts you to pick which ones to keep. To install only specific ones, add `--skill <name>` (repeat the flag to install several, e.g. `--skill canvas --skill sound`). Use `--list` instead of installing to just see what's available. Available skills:

* `getting-started` — installing the package and initializing the `Game`
* `assets` — local vs. online assets, the manifest/bundle/alias system, and loading strategy
* `canvas` — images, sprites, text, video, transitions and effects
* `characters` — defining and registering characters
* `history` — going back/rewinding and reading the narration backlog
* `narration` — labels, dialogue and choices
* `saves` — exporting/restoring game state and persisting save files
* `sound` — music, sound effects and audio channels
* `storage` — game variables, flags and stored classes
* `testing` — driving/inspecting a running game from an AI agent or script via `Game.testing`, for automated play-testing
* `ui` — mounting HTML/PixiJS UI layers over the canvas, screen navigation, theming, and connecting UI to storage
* `migration` — upgrading an existing project to the current version


# Class: CachedMap<K, V> (/pixi-vn/index/classes/CachedMap)



Defined in: [src/classes/CachedMap.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L3)

## Type Parameters [#type-parameters]

### K [#k]

`K` *extends* `object`

### V [#v]

`V` *extends* `object`

## Implements [#implements]

* `Map`\<`K`, `V`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CachedMap**\<`K`, `V`>(`options`): `CachedMap`\<`K`, `V`>

Defined in: [src/classes/CachedMap.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L6)

#### Parameters [#parameters]

##### options [#options]

###### cacheSize [#cachesize]

`number`

#### Returns [#returns]

`CachedMap`\<`K`, `V`>

## Properties [#properties]

### cache [#cache]

\> `readonly` **cache**: `LRUCache`\<`K`, `V`>

Defined in: [src/classes/CachedMap.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L4)

***

### map [#map]

\> `readonly` **map**: `Map`\<`K`, `V`>

Defined in: [src/classes/CachedMap.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L5)

## Accessors [#accessors]

### \[iterator] [#iterator]

#### Get Signature [#get-signature]

\> **get** **\[iterator]**(): () => `MapIterator`\<\[`K`, `V`]>

Defined in: [src/classes/CachedMap.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L12)

##### Returns [#returns-1]

\> (): `MapIterator`\<\[`K`, `V`]>

Returns an iterable of entries in the map.

###### Returns [#returns-2]

`MapIterator`\<\[`K`, `V`]>

#### Implementation of [#implementation-of]

`Map.[iterator]`

***

### \[toStringTag] [#tostringtag]

#### Get Signature [#get-signature-1]

\> **get** **\[toStringTag]**(): `string`

Defined in: [src/classes/CachedMap.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L15)

##### Returns [#returns-3]

`string`

#### Implementation of [#implementation-of-1]

`Map.[toStringTag]`

***

### forEach [#foreach]

#### Get Signature [#get-signature-2]

\> **get** **forEach**(): (`callbackfn`, `thisArg?`) => `void`

Defined in: [src/classes/CachedMap.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L29)

Executes a provided function once per each key/value pair in the Map, in insertion order.

##### Returns [#returns-4]

\> (`callbackfn`, `thisArg?`): `void`

Executes a provided function once per each key/value pair in the Map, in insertion order.

###### Parameters [#parameters-1]

###### callbackfn [#callbackfn]

(`value`, `key`, `map`) => `void`

###### thisArg? [#thisarg]

`any`

###### Returns [#returns-5]

`void`

#### Implementation of [#implementation-of-2]

`Map.forEach`

***

### size [#size]

#### Get Signature [#get-signature-3]

\> **get** **size**(): `number`

Defined in: [src/classes/CachedMap.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L47)

##### Returns [#returns-6]

`number`

the number of elements in the Map.

#### Implementation of [#implementation-of-3]

`Map.size`

## Methods [#methods]

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/classes/CachedMap.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L18)

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-4]

`Map.clear`

***

### delete() [#delete]

\> **delete**(`key`): `boolean`

Defined in: [src/classes/CachedMap.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L22)

#### Parameters [#parameters-2]

##### key [#key]

`K`

#### Returns [#returns-8]

`boolean`

true if an element in the Map existed and has been removed, or false if the element does not exist.

#### Implementation of [#implementation-of-5]

`Map.delete`

***

### entries() [#entries]

\> **entries**(): `MapIterator`\<\[`K`, `V`]>

Defined in: [src/classes/CachedMap.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L50)

Returns an iterable of key, value pairs for every entry in the map.

#### Returns [#returns-9]

`MapIterator`\<\[`K`, `V`]>

#### Implementation of [#implementation-of-6]

`Map.entries`

***

### get() [#get]

\> **get**(`key`): `V` | `undefined`

Defined in: [src/classes/CachedMap.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L32)

Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

#### Parameters [#parameters-3]

##### key [#key-1]

`K`

#### Returns [#returns-10]

`V` | `undefined`

Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

#### Implementation of [#implementation-of-7]

`Map.get`

***

### has() [#has]

\> **has**(`key`): `boolean`

Defined in: [src/classes/CachedMap.ts:39](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L39)

#### Parameters [#parameters-4]

##### key [#key-2]

`K`

#### Returns [#returns-11]

`boolean`

boolean indicating whether an element with the specified key exists or not.

#### Implementation of [#implementation-of-8]

`Map.has`

***

### keys() [#keys]

\> **keys**(): `MapIterator`\<`K`>

Defined in: [src/classes/CachedMap.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L53)

Returns an iterable of keys in the map

#### Returns [#returns-12]

`MapIterator`\<`K`>

#### Implementation of [#implementation-of-9]

`Map.keys`

***

### set() [#set]

\> **set**(`key`, `value`): `this`

Defined in: [src/classes/CachedMap.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L42)

Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

#### Parameters [#parameters-5]

##### key [#key-3]

`K`

##### value [#value]

`V`

#### Returns [#returns-13]

`this`

#### Implementation of [#implementation-of-10]

`Map.set`

***

### values() [#values]

\> **values**(): `MapIterator`\<`V`>

Defined in: [src/classes/CachedMap.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/classes/CachedMap.ts#L56)

Returns an iterable of values in the map

#### Returns [#returns-14]

`MapIterator`\<`V`>

#### Implementation of [#implementation-of-11]

`Map.values`


# Class: CanvasBaseItem<T2> (/pixi-vn/index/classes/CanvasBaseItem)



Defined in: [src/canvas/classes/CanvasBaseItem.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L31)

This class is used to create a canvas element to add into a Pixi Application.
You can use [()](/pixi-vn/index/interfaces/CanvasManagerInterface#add) to add this element into the application.
This class should be implemented and the memory method should be overridden.
You must use the [canvasComponentDecorator](/pixi-vn/index/namespaces/RegisteredCanvasComponents) to register the canvas in the game.
In Ren'Py is a displayable.

## Example [#example]

```ts
const CANVAS_EXAMPLE_ID = "CanvasExample";

\@canvasComponentDecorator({
    name: CANVAS_EXAMPLE_ID,
})
export class CanvasExample extends Container implements CanvasBaseItem<Memory> {
    get memory(): Memory {
        return {
            pixivnId: CANVAS_EXAMPLE_ID,
            // ... other properties
        }
    }
    async setMemory(value: Memory) {
        // ... set other properties
    }
}
```

## Extended by [#extended-by]

* [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)

## Type Parameters [#type-parameters]

### T2 [#t2]

`T2` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CanvasBaseItem**\<`T2`>(...`_options`): `CanvasBaseItem`\<`T2`>

Defined in: [src/canvas/classes/CanvasBaseItem.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L32)

#### Parameters [#parameters]

##### \_options [#_options]

...`any`

#### Returns [#returns]

`CanvasBaseItem`\<`T2`>

## Properties [#properties]

### pixivnId [#pixivnid]

\> **pixivnId**: `string` = `"canvas_element_id_not_set"`

Defined in: [src/canvas/classes/CanvasBaseItem.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L56)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

## Accessors [#accessors]

### memory [#memory]

#### Get Signature [#get-signature]

\> **get** **memory**(): `T2`

Defined in: [src/canvas/classes/CanvasBaseItem.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L37)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-1]

`T2`

## Methods [#methods]

### setMemory() [#setmemory]

\> **setMemory**(`_value`): `void` | `Promise`\<`void`>

Defined in: [src/canvas/classes/CanvasBaseItem.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L47)

This method set the memory of the canvas element.

#### Parameters [#parameters-1]

##### \_value [#_value]

`T2`

#### Returns [#returns-2]

`void` | `Promise`\<`void`>

#### Throws [#throws-1]

when the method is not overridden in the subclass.


# Class: CanvasManagerStatic (/pixi-vn/index/classes/CanvasManagerStatic)



Defined in: [src/canvas/CanvasManagerStatic.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L12)

This class is responsible for managing the canvas, the tickers, the events, and the window size and the children of the window.

## Properties [#properties]

### \_isInitialized [#_isinitialized]

\> `static` **\_isInitialized**: `boolean` = `false`

Defined in: [src/canvas/CanvasManagerStatic.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L44)

***

### canvasHeight [#canvasheight]

\> `static` **canvasHeight**: `number` = `300`

Defined in: [src/canvas/CanvasManagerStatic.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L43)

***

### canvasWidth [#canvaswidth]

\> `static` **canvasWidth**: `number` = `300`

Defined in: [src/canvas/CanvasManagerStatic.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L42)

***

### htmlLayers [#htmllayers]

\> `static` **htmlLayers**: `HTMLElement`\[] = `[]`

Defined in: [src/canvas/CanvasManagerStatic.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L41)

This is the div that have same size of the canvas.
This is useful to put interface elements.
You can use React or other framework to put elements in this div.

## Accessors [#accessors]

### app [#app]

#### Get Signature [#get-signature]

\> **get** `static` **app**(): `Application`\<`Renderer`>

Defined in: [src/canvas/CanvasManagerStatic.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L20)

The Pixi.js application instance.

##### Throws [#throws]

when the canvas has not been initialized yet (i.e. before calling `Game.init()`).

##### Returns [#returns]

`Application`\<`Renderer`>

***

### childrenAliasesOrder [#childrenaliasesorder]

#### Get Signature [#get-signature-1]

\> **get** `static` **childrenAliasesOrder**(): `string`\[]

Defined in: [src/canvas/CanvasManagerStatic.ts:213](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L213)

The order of the elements in the canvas, is determined by the zIndex.

##### Returns [#returns-1]

`string`\[]

***

### gameLayer [#gamelayer]

#### Get Signature [#get-signature-2]

\> **get** `static` **gameLayer**(): `Container`\<`ContainerChild`>

Defined in: [src/canvas/CanvasManagerStatic.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L27)

##### Returns [#returns-2]

`Container`\<`ContainerChild`>

## Methods [#methods]

### addHtmlLayer() [#addhtmllayer]

\> `static` **addHtmlLayer**(`id`, `element`, `style?`): `HTMLDivElement`

Defined in: [src/canvas/CanvasManagerStatic.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L130)

#### Parameters [#parameters]

##### id [#id]

`string`

##### element [#element]

`HTMLElement`

##### style? [#style]

`Partial`\<`Pick`\<`CSSStyleDeclaration`, `"position"` | `"pointerEvents"` | `"userSelect"`>> = `{}`

#### Returns [#returns-3]

`HTMLDivElement`

***

### getHtmlLayer() [#gethtmllayer]

\> `static` **getHtmlLayer**(`id`): `HTMLElement` | `undefined`

Defined in: [src/canvas/CanvasManagerStatic.ts:155](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L155)

#### Parameters [#parameters-1]

##### id [#id-1]

`string`

#### Returns [#returns-4]

`HTMLElement` | `undefined`

***

### init() [#init]

\> `static` **init**(`element`, `options?`, `devtoolsOptions?`): `Promise`\<`void`>

Defined in: [src/canvas/CanvasManagerStatic.ts:46](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L46)

#### Parameters [#parameters-2]

##### element [#element-1]

`HTMLElement`

##### options? [#options]

`Partial`\<[`ApplicationOptions`](/pixi-vn/index/interfaces/ApplicationOptions)> & `object`

##### devtoolsOptions? [#devtoolsoptions]

`Devtools`

#### Returns [#returns-5]

`Promise`\<`void`>

***

### removeHtmlLayer() [#removehtmllayer]

\> `static` **removeHtmlLayer**(`id`): `void`

Defined in: [src/canvas/CanvasManagerStatic.ts:146](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/CanvasManagerStatic.ts#L146)

#### Parameters [#parameters-3]

##### id [#id-2]

`string`

#### Returns [#returns-6]

`void`


# Class: CharacterBaseModel (/pixi-vn/index/classes/CharacterBaseModel)



Defined in: [src/characters/classes/CharacterBaseModel.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L33)

CharacterBaseModel is a class that is used to create a character model.
You must use the [RegisteredCharacters.add](/pixi-vn/index/namespaces/RegisteredCharacters/functions/add) function to save the character in the game.
It is raccomended to create your own class Character, read more here: [https://pixi-vn.com/start/character.html#custom-character](https://pixi-vn.com/start/character.html#custom-character)

## Example [#example]

```ts
import { CharacterBaseModel, RegisteredCharacters } from "@drincs/pixi-vn";

export const liam = new CharacterBaseModel("liam", {
    name: "Liam",
    surname: "Smith",
    age: 25,
    icon: "https://example.com/liam.png",
    color: "#9e2e12",
});

export const emma = new CharacterBaseModel("emma", {
    name: "Emma",
    surname: "Johnson",
    age: 23,
    icon: "https://example.com/emma.png",
    color: "#9e2e12",
});

RegisteredCharacters.add([liam, emma]);
```

## Extends [#extends]

* [`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CharacterBaseModel**(`id`, `props`): `CharacterBaseModel`

Defined in: [src/characters/classes/CharacterBaseModel.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L38)

#### Parameters [#parameters]

##### id [#id]

`string` | [`CharacterEmotionId`](/pixi-vn/index/interfaces/CharacterEmotionId)

A unique identifier (string). It is used to reference the character in the game (must be unique). If you want to create a character with an "emotion", you can pass an object.

##### props [#props]

`CharacterBaseModelProps`

The properties of the character.

#### Returns [#returns]

`CharacterBaseModel`

#### Overrides [#overrides]

[`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass).[`constructor`](/pixi-vn/index/classes/CharacterStoredClass#constructor)

## Properties [#properties]

### color? [#color]

\> `readonly` `optional` **color?**: `string`

Defined in: [src/characters/classes/CharacterBaseModel.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L86)

The color of the character.

***

### defaultAge? [#defaultage]

\> `readonly` `optional` **defaultAge?**: `number`

Defined in: [src/characters/classes/CharacterBaseModel.ts:68](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L68)

***

### defaultName? [#defaultname]

\> `readonly` `optional` **defaultName?**: `string`

Defined in: [src/characters/classes/CharacterBaseModel.ts:46](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L46)

***

### defaultSurname? [#defaultsurname]

\> `readonly` `optional` **defaultSurname?**: `string`

Defined in: [src/characters/classes/CharacterBaseModel.ts:57](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L57)

***

### icon? [#icon]

\> `readonly` `optional` **icon?**: `string`

Defined in: [src/characters/classes/CharacterBaseModel.ts:82](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L82)

The icon of the character.

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/storage/classes/StoredClassModel.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L63)

Is id of the stored class. is unique for this class.

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

[`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass).[`id`](/pixi-vn/index/classes/CharacterStoredClass#id)

## Accessors [#accessors]

### age [#age]

#### Get Signature [#get-signature]

\> **get** **age**(): `number` | `undefined`

Defined in: [src/characters/classes/CharacterBaseModel.ts:73](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L73)

The age of the character.
If you set undefined, it will return the default age.

##### Returns [#returns-1]

`number` | `undefined`

#### Set Signature [#set-signature]

\> **set** **age**(`value`): `void`

Defined in: [src/characters/classes/CharacterBaseModel.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L76)

##### Parameters [#parameters-1]

###### value [#value]

`number` | `undefined`

##### Returns [#returns-2]

`void`

***

### name [#name]

#### Get Signature [#get-signature-1]

\> **get** **name**(): `string`

Defined in: [src/characters/classes/CharacterBaseModel.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L51)

The name of the character.
If you set undefined, it will return the default name.

##### Returns [#returns-3]

`string`

#### Set Signature [#set-signature-1]

\> **set** **name**(`value`): `void`

Defined in: [src/characters/classes/CharacterBaseModel.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L54)

##### Parameters [#parameters-2]

###### value [#value-1]

`string` | `undefined`

##### Returns [#returns-4]

`void`

***

### surname [#surname]

#### Get Signature [#get-signature-2]

\> **get** **surname**(): `string` | `undefined`

Defined in: [src/characters/classes/CharacterBaseModel.ts:62](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L62)

The surname of the character.
If you set undefined, it will return the default surname.

##### Returns [#returns-5]

`string` | `undefined`

#### Set Signature [#set-signature-2]

\> **set** **surname**(`value`): `void`

Defined in: [src/characters/classes/CharacterBaseModel.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterBaseModel.ts#L65)

##### Parameters [#parameters-3]

###### value [#value-2]

`string` | `undefined`

##### Returns [#returns-6]

`void`

## Methods [#methods]

### getStorageProperty() [#getstorageproperty]

\> **getStorageProperty**\<`T`>(`propertyName`): `T` | `undefined`

Defined in: [src/characters/classes/CharacterStoredClass.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterStoredClass.ts#L16)

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T`

#### Parameters [#parameters-4]

##### propertyName [#propertyname]

`string`

The name of the property to get.

#### Returns [#returns-7]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

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

[`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass).[`getStorageProperty`](/pixi-vn/index/classes/CharacterStoredClass#getstorageproperty)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L43)

#### Parameters [#parameters-5]

##### oldCategoryId? [#oldcategoryid]

`string` = `...`

#### Returns [#returns-8]

`void`

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

[`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass).[`migrateOldStorage`](/pixi-vn/index/classes/CharacterStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L71)

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-6]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-3]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-9]

`void`

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

[`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass).[`setStorageProperty`](/pixi-vn/index/classes/CharacterStoredClass#setstorageproperty)


# Class: CharacterStoredClass (/pixi-vn/index/classes/CharacterStoredClass)



Defined in: [src/characters/classes/CharacterStoredClass.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterStoredClass.ts#L5)

StoredClassModel is a abstract class that contains the methods to store a class in the game.
I suggest you extend this class to create your own stored class.

## Example [#example]

```ts
export class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
    constructor(id: string, props: CharacterBaseModelProps) {
        super("___character___", id)
        this.defaultName = props.name
        this.defaultSurname = props.surname
    }
    readonly defaultName: string = ""
    get name(): string {
        return this.getStorageProperty<string>("name") || this.defaultName
    }
    set name(value: string) {
        this.setStorageProperty("name", value)
    }
    readonly defaultSurname?: string
    get surname(): string | undefined {
        return this.getStorageProperty<string>("surname") || this.defaultSurname
    }
    set surname(value: string | undefined) {
        this.setStorageProperty("surname", value)
    }
}
```

## Extends [#extends]

* [`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel)

## Extended by [#extended-by]

* [`CharacterBaseModel`](/pixi-vn/index/classes/CharacterBaseModel)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CharacterStoredClass**(`id`, `emotion?`): `CharacterStoredClass`

Defined in: [src/characters/classes/CharacterStoredClass.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterStoredClass.ts#L7)

#### Parameters [#parameters]

##### id [#id]

`string`

##### emotion? [#emotion]

`string` = `""`

#### Returns [#returns]

`CharacterStoredClass`

#### Overrides [#overrides]

[`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel).[`constructor`](/pixi-vn/index/classes/StoredClassModel#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/storage/classes/StoredClassModel.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L63)

Is id of the stored class. is unique for this class.

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

[`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel).[`id`](/pixi-vn/index/classes/StoredClassModel#id)

## Methods [#methods]

### getStorageProperty() [#getstorageproperty]

\> **getStorageProperty**\<`T`>(`propertyName`): `T` | `undefined`

Defined in: [src/characters/classes/CharacterStoredClass.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/classes/CharacterStoredClass.ts#L16)

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T`

#### Parameters [#parameters-1]

##### propertyName [#propertyname]

`string`

The name of the property to get.

#### Returns [#returns-1]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Overrides [#overrides-1]

[`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel).[`getStorageProperty`](/pixi-vn/index/classes/StoredClassModel#getstorageproperty)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L43)

#### Parameters [#parameters-2]

##### oldCategoryId? [#oldcategoryid]

`string` = `...`

#### Returns [#returns-2]

`void`

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

[`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel).[`migrateOldStorage`](/pixi-vn/index/classes/StoredClassModel#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L71)

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-3]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-3]

`void`

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

[`StoredClassModel`](/pixi-vn/index/classes/StoredClassModel).[`setStorageProperty`](/pixi-vn/index/classes/StoredClassModel#setstorageproperty)


# Class: Container<C, Memory> (/pixi-vn/index/classes/Container)



Defined in: [src/canvas/components/Container.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L42)

This class is a extension of the [PIXI.Container class](https://pixijs.com/8.x/examples/basic/container), it has the same properties and methods,
but it has the ability to be saved and loaded by the Pixi’VN library.

## Example [#example]

```ts
 const container = new Container();
 canvas.add(container);
 const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
 for (let i = 0; i < 25; i++)
 {
     const bunny = new Sprite(texture);
     bunny.x = (i % 5) * 40;
     bunny.y = Math.floor(i / 5) * 40;
     container.addChild(bunny);
 }
```

## Extends [#extends]

* `Container`\<`C`>

## Extended by [#extended-by]

* [`ImageContainer`](/pixi-vn/index/classes/ImageContainer)

## Type Parameters [#type-parameters]

### C [#c]

`C` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild) = [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

### Memory [#memory]

`Memory` *extends* [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory) = [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)

## Implements [#implements]

* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`Memory`>
* [`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension)
* [`AnchorExtension`](/pixi-vn/index/interfaces/AnchorExtension)
* [`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Container**\<`C`, `Memory`>(`options?`): `Container`\<`C`, `Memory`>

Defined in: [src/canvas/components/Container.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L53)

#### Parameters [#parameters]

##### options? [#options]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions)\<`C`>

#### Returns [#returns]

`Container`\<`C`, `Memory`>

#### Overrides [#overrides]

`PixiContainer<C>.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

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

`PixiContainer.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

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

`PixiContainer.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

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

`PixiContainer.__devtoolLocked`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

`PixiContainer._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

`PixiContainer._cy`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

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

`PixiContainer._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

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

`PixiContainer._position`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

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

`PixiContainer._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

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

`PixiContainer._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

`PixiContainer._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

`PixiContainer._sy`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

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

`PixiContainer._zIndex`

***

### accessible? [#accessible]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

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

`PixiContainer.accessible`

***

### accessibleChildren? [#accessiblechildren]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

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

`PixiContainer.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

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

`PixiContainer.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

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

`PixiContainer.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

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

`PixiContainer.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

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

`PixiContainer.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

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

`PixiContainer.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:10

**`Internal`**

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

`PixiContainer.allowChildren`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

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

`PixiContainer.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

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

`PixiContainer.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

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

`PixiContainer.cacheAsTexture`

***

### children [#children]

\> `readonly` **children**: `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](#addchild) For adding children
* [Container#removeChild](#removechild) For removing children

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

`PixiContainer.children`

***

### cullable? [#cullable]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

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

`PixiContainer.cullable`

***

### cullableChildren? [#cullablechildren]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

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

`PixiContainer.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

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

`PixiContainer.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

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

`PixiContainer.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

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

`PixiContainer.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](#destroy) For destroying objects

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

`PixiContainer.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

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

`PixiContainer.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

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

`PixiContainer.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

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

`PixiContainer.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

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

`PixiContainer.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

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

`PixiContainer.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

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

`PixiContainer.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

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

`PixiContainer.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

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

`PixiContainer.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

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

`PixiContainer.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

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

`PixiContainer.hitArea`

***

### interactive? [#interactive]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

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

`PixiContainer.interactive`

***

### interactiveChildren? [#interactivechildren]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

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

`PixiContainer.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](#cacheastexture) For enabling caching
* [Container#updateCacheTexture](#updatecachetexture) For updating cache

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

`PixiContainer.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

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

`PixiContainer.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

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

`PixiContainer.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

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

`PixiContainer.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

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

`PixiContainer.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

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

`PixiContainer.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

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

`PixiContainer.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

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

`PixiContainer.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

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

`PixiContainer.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

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

`PixiContainer.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

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

`PixiContainer.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Container.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L93)

ListenerExtension

#### Implementation of [#implementation-of]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`onEventsHandlers`](/pixi-vn/index/interfaces/ListenerExtension#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

`PixiContainer.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

`PixiContainer.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

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

`PixiContainer.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

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

`PixiContainer.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

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

`PixiContainer.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

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

`PixiContainer.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

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

`PixiContainer.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

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

`PixiContainer.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

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

`PixiContainer.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

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

`PixiContainer.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

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

`PixiContainer.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

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

`PixiContainer.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

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

`PixiContainer.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

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

`PixiContainer.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

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

`PixiContainer.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

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

`PixiContainer.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

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

`PixiContainer.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

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

`PixiContainer.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

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

`PixiContainer.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

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

`PixiContainer.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

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

`PixiContainer.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

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

`PixiContainer.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

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

`PixiContainer.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

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

`PixiContainer.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

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

`PixiContainer.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

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

`PixiContainer.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

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

`PixiContainer.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

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

`PixiContainer.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

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

`PixiContainer.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

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

`PixiContainer.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

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

`PixiContainer.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

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

`PixiContainer.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](#addchild) For adding to a parent
* [Container#removeChild](#removechild) For removing from parent

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

`PixiContainer.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

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

`PixiContainer.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_CONTAINER_ID`

Defined in: [src/canvas/components/Container.ts:68](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L68)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Implementation of [#implementation-of-1]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`pixivnId`](/pixi-vn/index/classes/CanvasBaseItem#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

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

`PixiContainer.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:800

**`Internal`**

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

`PixiContainer.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

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

`PixiContainer.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

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

`PixiContainer.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

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

`PixiContainer.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

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

`PixiContainer.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

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

`PixiContainer.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

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

`PixiContainer.prefixed`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Container.ts:160](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L160)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:148](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L148)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-2]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

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

`PixiContainer.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `PointData`

Defined in: [src/canvas/components/Container.ts:119](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L119)

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-66]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Returns [#returns-10]

`PointData`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:124](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L124)

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-67]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

#### Example [#example-68]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

#### Implementation of [#implementation-of-3]

[`AnchorExtension`](/pixi-vn/index/interfaces/AnchorExtension).[`anchor`](/pixi-vn/index/interfaces/AnchorExtension#anchor)

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-69]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

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

`PixiContainer.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-70]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

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

`PixiContainer.blendMode`

***

### filters [#filters]

#### Get Signature [#get-signature-5]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-71]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-16]

Filter For filter base class

##### Returns [#returns-16]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-72]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-17]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-17]

`void`

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

`PixiContainer.filters`

***

### height [#height]

#### Get Signature [#get-signature-6]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-73]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-18]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-19]

`void`

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

`PixiContainer.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-7]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-20]

`boolean`

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

`PixiContainer.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-8]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-21]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-22]

`void`

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

`PixiContainer.isRenderGroup`

***

### memory [#memory-1]

#### Get Signature [#get-signature-9]

\> **get** **memory**(): `Memory`

Defined in: [src/canvas/components/Container.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L69)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-23]

`Memory`

#### Implementation of [#implementation-of-4]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`memory`](/pixi-vn/index/classes/CanvasBaseItem#memory)

***

### origin [#origin]

#### Get Signature [#get-signature-10]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-74]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-24]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-25]

`void`

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

`PixiContainer.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-11]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Container.ts:231](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L231)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-26]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:219](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L219)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-27]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-5]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-12]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Container.ts:245](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L245)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-28]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Container.ts:237](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L237)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-29]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-6]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-13]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Container.ts:256](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L256)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-30]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Container.ts:248](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L248)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-31]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-7]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-14]

\> **get** **pivot**(): `ObservablePoint`

Defined in: [src/canvas/components/Container.ts:137](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L137)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-75]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-32]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L140)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-76]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-3]

4.0.0

##### Parameters [#parameters-14]

###### value [#value-10]

`ObservablePoint`

##### Returns [#returns-33]

`void`

#### Overrides [#overrides-1]

`PixiContainer.pivot`

***

### position [#position]

#### Get Signature [#get-signature-15]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Container.ts:323](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L323)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-77]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Returns [#returns-34]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:326](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L326)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-78]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-5]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-35]

`void`

#### Overrides [#overrides-2]

`PixiContainer.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-16]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Container.ts:267](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L267)

##### Returns [#returns-36]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:277](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L277)

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-37]

`void`

#### Implementation of [#implementation-of-8]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionInfo`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-17]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Container.ts:259](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L259)

##### Returns [#returns-38]

`"pixel"` | `"percentage"` | `"align"`

#### Implementation of [#implementation-of-9]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionType`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-18]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-79]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-18]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-39]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-40]

`void`

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

`PixiContainer.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-19]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-80]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-41]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-42]

`void`

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

`PixiContainer.rotation`

***

### scale [#scale]

#### Get Signature [#get-signature-20]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-81]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-6]

4.0.0

##### Returns [#returns-43]

`ObservablePoint`

#### Set Signature [#set-signature-17]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-19]

###### value [#value-15]

`string` | `number` | `PointData`

##### Returns [#returns-44]

`void`

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

`PixiContainer.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-21]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-82]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-7]

4.0.0

##### Default [#default-55]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-45]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-20]

###### value [#value-16]

`PointData`

##### Returns [#returns-46]

`void`

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

`PixiContainer.skew`

***

### tint [#tint]

#### Get Signature [#get-signature-22]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-83]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-56]

```ts
0xFFFFFF
```

##### See [#see-19]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-47]

`number`

#### Set Signature [#set-signature-19]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-21]

###### value [#value-17]

`ColorSource`

##### Returns [#returns-48]

`void`

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

`PixiContainer.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-23]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-84]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-57]

```ts
true
```

##### See [#see-20]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-49]

`boolean`

#### Set Signature [#set-signature-20]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-22]

###### value [#value-18]

`boolean`

##### Returns [#returns-50]

`void`

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

`PixiContainer.visible`

***

### width [#width]

#### Get Signature [#get-signature-24]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-85]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-51]

`number`

#### Set Signature [#set-signature-21]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-23]

###### value [#value-19]

`number`

##### Returns [#returns-52]

`void`

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

`PixiContainer.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-25]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-86]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-21]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-53]

`Matrix`

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

`PixiContainer.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-26]

\> **get** **x**(): `number`

Defined in: [src/canvas/components/Container.ts:331](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L331)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-87]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-54]

`number`

#### Set Signature [#set-signature-22]

\> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L334)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-88]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-24]

###### value [#value-20]

`number`

##### Returns [#returns-55]

`void`

#### Overrides [#overrides-3]

`PixiContainer.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-27]

\> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Container.ts:188](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L188)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-56]

`number`

#### Set Signature [#set-signature-23]

\> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L180)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-25]

###### value [#value-21]

`number`

##### Returns [#returns-57]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-10]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-28]

\> **get** **y**(): `number`

Defined in: [src/canvas/components/Container.ts:339](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L339)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-89]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-58]

`number`

#### Set Signature [#set-signature-24]

\> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:342](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L342)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-90]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-59]

`void`

#### Overrides [#overrides-4]

`PixiContainer.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-29]

\> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Container.ts:207](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L207)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-60]

`number`

#### Set Signature [#set-signature-25]

\> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L199)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-61]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-11]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-28]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-62]

`void`

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

`PixiContainer._getGlobalBoundsRecursive`

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `C`\[]

#### Parameters [#parameters-29]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-63]

`U`\[`0`]

The first child that was added

#### Example [#example-91]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-22]

* [Container#removeChild](#removechild) For removing children
* [Container#addChildAt](#addchildat) For adding at specific index

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

`PixiContainer.addChild`

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-30]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-64]

`U`

The child that was added

#### Example [#example-92]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-23]

* [Container#addChild](#addchild) For adding to the end
* [Container#setChildIndex](#setchildindex) For moving existing children

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

`PixiContainer.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-31]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-65]

`void`

##### Example [#example-93]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

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

`PixiContainer.addEventListener`

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-32]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-66]

`void`

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

`PixiContainer.addEventListener`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-33]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-67]

`this`

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

`PixiContainer.addListener`

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-34]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-68]

`void`

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

`PixiContainer.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:30

**`Internal`**

Collects renderables using a simple method, suitable for containers marked as simple.
This method iterates over the container's children and adds their renderables to the instruction set.

#### Parameters [#parameters-35]

##### instructionSet [#instructionset-1]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-1]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-69]

`void`

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

`PixiContainer.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-36]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-70]

`void`

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

`PixiContainer.collectRenderablesWithEffects`

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1343

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling `destroy`.

#### Parameters [#parameters-37]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-71]

`void`

#### Example [#example-94]

```ts
container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });
```

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

`PixiContainer.destroy`

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-72]

`void`

#### Advanced [#advanced-9]

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

`PixiContainer.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-38]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-73]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-95]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

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

`PixiContainer.dispatchEvent`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-39]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`C`> & `AnyEvent`>\[`Extract`\<`T`, keyof AnyEvent | keyof ContainerEvents\<C>>]

#### Returns [#returns-74]

`boolean`

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

`PixiContainer.emit`

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-75]

`void`

#### Advanced [#advanced-10]

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

`PixiContainer.enableRenderGroup`

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof AnyEvent | keyof ContainerEvents\<C>)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-76]

(keyof AnyEvent | keyof ContainerEvents\<C>)\[]

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

`PixiContainer.eventNames`

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-40]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-1]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-77]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-96]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-24]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

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

`PixiContainer.getBounds`

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-41]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-78]

`U`

The child at the given index

#### Example [#example-97]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-25]

* [Container#children](#children) For direct array access
* [Container#getChildByLabel](#getchildbylabel) For name-based lookup

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

`PixiContainer.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-42]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-79]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-98]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-26]

* [Container#getChildrenByLabel](#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

`PixiContainer.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-43]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-80]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-27]

Container#getChildByLabel

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

`PixiContainer.getChildByName`

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-44]

##### child [#child-1]

`C`

The Container instance to identify

#### Returns [#returns-81]

`number`

The index position of the child container

#### Example [#example-99]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-28]

* [Container#setChildIndex](#setchildindex) For changing index
* [Container#children](#children) For direct array access

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

`PixiContainer.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-45]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-82]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-100]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-29]

* [Container#getChildByLabel](#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

`PixiContainer.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-46]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-2]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-83]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

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

`PixiContainer.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-47]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-84]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-101]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

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

`PixiContainer.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-48]

##### point? [#point]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-85]

`Point`

The updated point

#### Example [#example-102]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-30]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

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

`PixiContainer.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-49]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-86]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-103]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

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

`PixiContainer.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-50]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-87]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

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

`PixiContainer.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-88]

`Bounds`

The bounding area

#### Example [#example-105]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-31]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

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

`PixiContainer.getLocalBounds`

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-51]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-89]

`Size`

The size of the container.

#### Example [#example-106]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

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

`PixiContainer.getSize`

***

### importChildren() [#importchildren]

\> `protected` **importChildren**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/Container.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L83)

#### Parameters [#parameters-52]

##### value [#value-24]

`Memory`

#### Returns [#returns-90]

`Promise`\<`void`>

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-53]

##### event [#event-2]

keyof AnyEvent | keyof ContainerEvents\<C>

#### Returns [#returns-91]

`number`

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

`PixiContainer.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-54]

##### event [#event-3]

`T`

#### Returns [#returns-92]

(...`args`) => `void`\[]

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

`PixiContainer.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-55]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-93]

`this`

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

`PixiContainer.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Container.ts:94](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L94)

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<C>

#### Parameters [#parameters-56]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-94]

`this`

#### Implementation of [#implementation-of-12]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`on`](/pixi-vn/index/interfaces/ListenerExtension#on)

#### Overrides [#overrides-5]

`PixiContainer.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-57]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-95]

`this`

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

`PixiContainer.once`

***

### reloadAnchor() [#reloadanchor]

\> `protected` **reloadAnchor**(): `void`

Defined in: [src/canvas/components/Container.ts:132](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L132)

#### Returns [#returns-96]

`void`

***

### reloadPosition() [#reloadposition]

\> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Container.ts:286](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L286)

#### Returns [#returns-97]

`void`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-58]

##### event? [#event-7]

keyof AnyEvent | keyof ContainerEvents\<C>

#### Returns [#returns-98]

`this`

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

`PixiContainer.removeAllListeners`

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `C`\[]

#### Parameters [#parameters-59]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-99]

`U`\[`0`]

The first child that was removed

#### Example [#example-107]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-32]

* [Container#addChild](#addchild) For adding children
* [Container#removeChildren](#removechildren) For removing multiple children

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

`PixiContainer.removeChild`

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-60]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-100]

`U`

The child that was removed

#### Example [#example-108]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-33]

* [Container#removeChild](#removechild) For removing specific children
* [Container#removeChildren](#removechildren) For removing multiple children

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

`PixiContainer.removeChildAt`

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-61]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-101]

`C`\[]

List of removed children

#### Example [#example-109]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-34]

* [Container#addChild](#addchild) For adding children
* [Container#removeChild](#removechild) For removing specific children

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

`PixiContainer.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-62]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-102]

`void`

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

`PixiContainer.removeEventListener`

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-63]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-103]

`void`

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

`PixiContainer.removeEventListener`

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-104]

`void`

#### Example [#example-110]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-35]

* [Container#addChild](#addchild) For adding to a new parent
* [Container#removeChild](#removechild) For parent removing children

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

`PixiContainer.removeFromParent`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<C>

#### Parameters [#parameters-64]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-105]

`this`

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

`PixiContainer.removeListener`

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `C`\[]

#### Parameters [#parameters-65]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-106]

`U`\[`0`]

The first child that was reparented

#### Example [#example-111]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-36]

* [Container#reparentChildAt](#reparentchildat) For index-specific reparenting
* [Container#addChild](#addchild) For simple parenting

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

`PixiContainer.reparentChild`

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-66]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-107]

`U`

The reparented child

#### Example [#example-112]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-37]

* [Container#reparentChild](#reparentchild) For appending reparented children
* [Container#addChildAt](#addchildat) For simple indexed parenting

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

`PixiContainer.reparentChildAt`

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

##### T [#t-7]

`T` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-67]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-108]

`void`

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

`PixiContainer.replaceChild`

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-68]

##### child [#child-4]

`C`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-109]

`void`

#### Example [#example-113]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-38]

* [Container#getChildIndex](#getchildindex) For getting current index
* [Container#swapChildren](#swapchildren) For swapping positions

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

`PixiContainer.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-69]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-110]

`void`

#### Example [#example-114]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-39]

* [Container#updateTransform](#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

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

`PixiContainer.setFromMatrix`

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-70]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-111]

`void`

#### Example [#example-115]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-40]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

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

`PixiContainer.setMask`

***

### setMemory() [#setmemory]

\> **setMemory**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/Container.ts:77](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L77)

This method set the memory of the canvas element.

#### Parameters [#parameters-71]

##### value [#value-25]

`Memory`

#### Returns [#returns-112]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Implementation of [#implementation-of-13]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`setMemory`](/pixi-vn/index/classes/CanvasBaseItem#setmemory)

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-72]

##### value [#value-26]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-113]

`void`

#### Example [#example-116]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

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

`PixiContainer.setSize`

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

#### Parameters [#parameters-73]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-114]

`void`

#### Example [#example-117]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-41]

* [Container#setChildIndex](#setchildindex) For direct index placement
* [Container#getChildIndex](#getchildindex) For getting current positions

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

`PixiContainer.swapChildren`

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-74]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-1]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-115]

`P`

The global position

#### Example [#example-118]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-42]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

`PixiContainer.toGlobal`

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-75]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-2]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-116]

`P`

A point object representing the position in local space

#### Example [#example-119]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-43]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

`PixiContainer.toLocal`

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-117]

`void`

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

`PixiContainer.updateLocalTransform`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-76]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-118]

`this`

This container, for chaining

#### Example [#example-120]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-44]

* [Container#setFromMatrix](#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

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

`PixiContainer.updateTransform`

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-77]

##### source [#source]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-119]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

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

`PixiContainer.mixin`


# Class: GameUnifier (/pixi-vn/index/classes/GameUnifier)



Defined in: [src/core/GameUnifier.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L14)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new GameUnifier**(): `GameUnifier`

#### Returns [#returns]

`GameUnifier`

## Properties [#properties]

### onEnd? [#onend]

\> `static` `optional` **onEnd?**: [`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)

Defined in: [src/core/GameUnifier.ts:532](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L532)

***

### runningStepsCount [#runningstepscount]

\> `static` **runningStepsCount**: `number` = `0`

Defined in: [src/core/GameUnifier.ts:518](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L518)

Count of currently executing steps.
If a step triggers a narration.continue(), this number is greater than 1.

## Accessors [#accessors]

### addHistoryItem [#addhistoryitem]

#### Get Signature [#get-signature]

\> **get** `static` **addHistoryItem**(): (`historyInfo?`, `opstions?`) => `void` | `Promise`\<`void`>

Defined in: [src/core/GameUnifier.ts:511](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L511)

Add a history step to the history.

##### Returns [#returns-1]

(`historyInfo?`, `opstions?`) => `void` | `Promise`\<`void`>

***

### animate [#animate]

#### Get Signature [#get-signature-1]

\> **get** `static` **animate**(): \<`T`>(`components`, `keyframes`, `options?`, `priority?`) => `string` | `undefined`

Defined in: [src/core/GameUnifier.ts:581](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L581)

This function is called to animate a component.

##### Default [#default]

```ts
UPDATE_PRIORITY.NORMAL
```

##### Returns [#returns-2]

The id of tickers.

\<`T`>(`components`, `keyframes`, `options?`, `priority?`) => `string` | `undefined`

***

### animateFilter [#animatefilter]

#### Get Signature [#get-signature-2]

\> **get** `static` **animateFilter**(): (`components`, `filter`, `keyframes`, `options?`, `priority?`, `apply?`, `cleanup?`) => `string` | `undefined`

Defined in: [src/core/GameUnifier.ts:605](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L605)

This function is called to animate a `Filter`'s own properties, or a plain numeric "progress"
value when no `filter` is given. See [animate](#animate) for animating a canvas element's properties
instead.

##### Returns [#returns-3]

The id of the ticker.

(`components`, `filter`, `keyframes`, `options?`, `priority?`, `apply?`, `cleanup?`) => `string` | `undefined`

***

### backRequestsCount [#backrequestscount]

#### Get Signature [#get-signature-3]

\> **get** `static` **backRequestsCount**(): `number`

Defined in: [src/core/GameUnifier.ts:364](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L364)

This function is called to get the number of pending back requests.
Returns the negation of navigationRequestsCount:

* Positive value (absolute value of navigationRequestsCount) when navigationRequestsCount is negative (back requests pending)
* Negative value when navigationRequestsCount is positive (continue requests pending)
* Zero when navigationRequestsCount is zero (no requests pending)
  If it is > 0, after the stepsRunning is 0, the previous step will be executed.

##### Returns [#returns-4]

`number`

***

### canvasComponentExists [#canvascomponentexists]

#### Get Signature [#get-signature-4]

\> **get** `static` **canvasComponentExists**(): (`alias`) => `boolean`

Defined in: [src/core/GameUnifier.ts:633](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L633)

Checks whether a canvas component with the given alias currently exists. See the
`canvasComponentExists` option of [init](#init) for why this exists.

##### Returns [#returns-5]

(`alias`) => `boolean`

***

### continueRequestsCount [#continuerequestscount]

#### Get Signature [#get-signature-5]

\> **get** `static` **continueRequestsCount**(): `number`

Defined in: [src/core/GameUnifier.ts:343](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L343)

This function is called to get the number of pending continue requests.
Returns a positive count of pending continue requests when navigationRequestsCount is positive.
If it is > 0, after the stepsRunning is 0, the next step will be executed.

##### Returns [#returns-6]

`number`

***

### currentGameStepState [#currentgamestepstate]

#### Get Signature [#get-signature-6]

\> **get** `static` **currentGameStepState**(): `GameStepState` | `Promise`\<`GameStepState`>

Defined in: [src/core/GameUnifier.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L262)

Returns the current state of the game step.

##### Throws [#throws]

when `Game.init()` has not been called yet.

##### Returns [#returns-7]

`GameStepState` | `Promise`\<`GameStepState`>

***

### getCharacter [#getcharacter]

#### Get Signature [#get-signature-7]

\> **get** `static` **getCharacter**(): (`id`) => `CharacterInterface` | `undefined`

Defined in: [src/core/GameUnifier.ts:528](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L528)

This function returns the character by its id.

##### Returns [#returns-8]

The character or undefined if it does not exist.

(`id`) => `CharacterInterface` | `undefined`

***

### getFlag [#getflag]

#### Get Signature [#get-signature-8]

\> **get** `static` **getFlag**(): (`name`) => `boolean`

Defined in: [src/core/GameUnifier.ts:464](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L464)

This function returns the value of a flag.

##### Returns [#returns-9]

(`name`) => `boolean`

***

### getVariable [#getvariable]

#### Get Signature [#get-signature-9]

\> **get** `static` **getVariable**(): \<`T`>(`prefix`, `key`) => `T` | `undefined`

Defined in: [src/core/GameUnifier.ts:420](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L420)

This function returns the value of a variable.

##### Returns [#returns-10]

The value of the variable.

\<`T`>(`prefix`, `key`) => `T` | `undefined`

***

### navigate [#navigate]

#### Get Signature [#get-signature-10]

\> **get** `static` **navigate**(): (`path`) => `void` | `Promise`\<`void`>

Defined in: [src/core/GameUnifier.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L217)

The navigate function.

##### Returns [#returns-11]

(`path`) => `void` | `Promise`\<`void`>

#### Set Signature [#set-signature]

\> **set** `static` **navigate**(`value`): `void`

Defined in: [src/core/GameUnifier.ts:220](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L220)

##### Parameters [#parameters]

###### value [#value]

(`path`) => `void` | `Promise`\<`void`>

##### Returns [#returns-12]

`void`

***

### onLabelClosing [#onlabelclosing]

#### Get Signature [#get-signature-11]

\> **get** `static` **onLabelClosing**(): (`openedLabelsNumber`) => `void`

Defined in: [src/core/GameUnifier.ts:488](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L488)

This function is called after the narration.continue() method is executed
It can be used to clear old temporary variables.

##### Returns [#returns-13]

(`openedLabelsNumber`) => `void`

***

### onPreContinue [#onprecontinue]

#### Get Signature [#get-signature-12]

\> **get** `static` **onPreContinue**(): () => `Promise`\<`void`>

Defined in: [src/core/GameUnifier.ts:324](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L324)

This function is called immediately before a narration "continue" operation.

##### Returns [#returns-14]

() => `Promise`\<`void`>

***

### openedLabels [#openedlabels]

#### Get Signature [#get-signature-13]

\> **get** `static` **openedLabels**(): `number`

Defined in: [src/core/GameUnifier.ts:294](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L294)

Returns the number of opened labels.

##### Throws [#throws-1]

when `Game.init()` has not been called yet.

##### Returns [#returns-15]

`number`

***

### removeCanvasComponent [#removecanvascomponent]

#### Get Signature [#get-signature-14]

\> **get** `static` **removeCanvasComponent**(): (`alias`) => `void`

Defined in: [src/core/GameUnifier.ts:619](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L619)

Removes one or more canvas components by alias. See the `removeCanvasComponent` option of
[init](#init) for why this exists.

##### Returns [#returns-16]

(`alias`) => `void`

***

### removeVariable [#removevariable]

#### Get Signature [#get-signature-15]

\> **get** `static` **removeVariable**(): (`prefix`, `key`) => `void`

Defined in: [src/core/GameUnifier.ts:450](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L450)

This function removes a variable.

##### Returns [#returns-17]

(`prefix`, `key`) => `void`

***

### restoreGameStepState [#restoregamestepstate]

#### Get Signature [#get-signature-16]

\> **get** `static` **restoreGameStepState**(): (`state`, `navigate`) => `Promise`\<`void`>

Defined in: [src/core/GameUnifier.ts:280](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L280)

Restores the game step state.

##### Returns [#returns-18]

(`state`, `navigate`) => `Promise`\<`void`>

***

### setFlag [#setflag]

#### Get Signature [#get-signature-17]

\> **get** `static` **setFlag**(): (`name`, `value`) => `void`

Defined in: [src/core/GameUnifier.ts:479](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L479)

This function sets the value of a flag.

##### Returns [#returns-19]

(`name`, `value`) => `void`

***

### setVariable [#setvariable]

#### Get Signature [#get-signature-18]

\> **get** `static` **setVariable**(): (`prefix`, `key`, `value`) => `void`

Defined in: [src/core/GameUnifier.ts:436](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L436)

This function sets the value of a variable.

##### Returns [#returns-20]

(`prefix`, `key`, `value`) => `void`

***

### stepCounter [#stepcounter]

#### Get Signature [#get-signature-19]

\> **get** `static` **stepCounter**(): `number`

Defined in: [src/core/GameUnifier.ts:241](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L241)

Returns the current step counter. This counter corresponds to the total number of steps that have been executed so far.

##### Throws [#throws-2]

when `Game.init()` has not been called yet.

##### Returns [#returns-21]

`number`

#### Set Signature [#set-signature-1]

\> **set** `static` **stepCounter**(`value`): `void`

Defined in: [src/core/GameUnifier.ts:248](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L248)

Returns the current state of the game step.

##### Throws [#throws-3]

when `Game.init()` has not been called yet.

##### Parameters [#parameters-1]

###### value [#value-1]

`number`

##### Returns [#returns-22]

`void`

## Methods [#methods]

### addOnError() [#addonerror]

\> `static` **addOnError**(`handler`): () => `void`

Defined in: [src/core/GameUnifier.ts:538](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L538)

#### Parameters [#parameters-2]

##### handler [#handler]

[`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)

#### Returns [#returns-23]

() => `void`

***

### addOnPreContinue() [#addonprecontinue]

\> `static` **addOnPreContinue**(`handler`): `void`

Defined in: [src/core/GameUnifier.ts:303](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L303)

Register a handler to run immediately before a narration "continue" operation.
Handlers are executed in registration order and may be async. Use
`{@link addOnPreContinue}` / `{@link removeOnPreContinue}` to manage them programmatically.

#### Parameters [#parameters-3]

##### handler [#handler-1]

() => `void` | `Promise`\<`void`>

#### Returns [#returns-24]

`void`

***

### clearOnErrorHandlers() [#clearonerrorhandlers]

\> `static` **clearOnErrorHandlers**(): `void`

Defined in: [src/core/GameUnifier.ts:547](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L547)

#### Returns [#returns-25]

`void`

***

### clearOnPreContinueHandlers() [#clearonprecontinuehandlers]

\> `static` **clearOnPreContinueHandlers**(): `void`

Defined in: [src/core/GameUnifier.ts:311](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L311)

#### Returns [#returns-26]

`void`

***

### increaseBackRequest() [#increasebackrequest]

\> `static` **increaseBackRequest**(`amount?`): `void`

Defined in: [src/core/GameUnifier.ts:374](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L374)

This function is called to increase the number of pending back requests.
Note: While the decrement operation itself is atomic, the overall navigation
processing uses a lock in processNavigationRequests to ensure atomicity of
read-modify-write operations across async boundaries.

#### Parameters [#parameters-4]

##### amount? [#amount]

`number` = `1`

The number of steps to increase. Default is 1.

#### Returns [#returns-27]

`void`

***

### increaseContinueRequest() [#increasecontinuerequest]

\> `static` **increaseContinueRequest**(`amount?`): `void`

Defined in: [src/core/GameUnifier.ts:353](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L353)

This function is called to increase the number of pending continue requests.
Note: While the increment operation itself is atomic, the overall navigation
processing uses a lock in processNavigationRequests to ensure atomicity of
read-modify-write operations across async boundaries.

#### Parameters [#parameters-5]

##### amount? [#amount-1]

`number` = `1`

The number of steps to increase. Default is 1.

#### Returns [#returns-28]

`void`

***

### init() [#init]

\> `static` **init**(`options`): `void`

Defined in: [src/core/GameUnifier.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L15)

#### Parameters [#parameters-6]

##### options [#options]

###### animate [#animate-1]

\<`T`>(`components`, `keyframes`, `options?`, `priority?`) => `string` | `undefined`

This function is called to animate a component.

**Default**

```ts
UPDATE_PRIORITY.NORMAL
```

###### animateFilter [#animatefilter-1]

(`components`, `filter`, `keyframes`, `options?`, `priority?`, `apply?`, `cleanup?`) => `string` | `undefined`

This function is called to animate either a `Filter`'s own properties, or a plain numeric
"progress" value with no live target (as opposed to [animate](#animate), which animates a canvas
element's properties). The latter is the generic mechanism behind the mask-based transitions
(wipe/iris/split): they have no canvas element or Filter property to write directly, just a
number and a side effect.

**Default**

```ts
UPDATE_PRIORITY.NORMAL
```

###### canvasComponentExists [#canvascomponentexists-1]

(`alias`) => `boolean`

This function checks whether a canvas component with the given alias currently exists. Used by
the `tickers` module to prune ticker/alias associations for components no longer on the canvas,
without importing `@drincs/pixi-vn/canvas` directly (see [removeCanvasComponent](#removecanvascomponent)).

###### getCharacter [#getcharacter-1]

(`id`) => `CharacterInterface` | `undefined`

This function returns the character by its id.

###### getCurrentGameStepState [#getcurrentgamestepstate]

() => `GameStepState` | `Promise`\<`GameStepState`>

This function returns the current state of the game step.

If your game engine does not have a history of steps, you can return an empty object.

###### getFlag [#getflag-1]

(`name`) => `boolean`

This function returns the value of a flag.

###### getOpenedLabels [#getopenedlabels]

() => `number`

This function returns the number of opened labels.

If your game engine does not have a narration system, you can return 0.

###### getStepCounter [#getstepcounter]

() => `number`

This function returns the current step counter. This counter corresponds to the total number of steps that have been executed so far.

If your game engine does not have a history of steps, you can return 0.

###### getVariable [#getvariable-1]

\<`T`>(`prefix`, `key`) => `T` | `undefined`

This function returns the value of a variable.

###### navigate? [#navigate-1]

(`path`) => `void` | `Promise`\<`void`>

The navigate function.

###### onLabelClosing? [#onlabelclosing-1]

(`openedLabelsNumber`) => `void`

This function is called after the narration.continue() method is executed.

It can be used to clear old temporary variables.

###### processNavigationRequests [#processnavigationrequests]

(`navigationRequestsCount`, `props`) => `object`

This function is called to process the pending navigation requests (continue/back).

###### removeCanvasComponent [#removecanvascomponent-1]

(`alias`) => `void`

This function removes one or more canvas components by alias. Used by the `tickers` module's
`onComplete` to honor `aliasToRemoveAfter` without importing `@drincs/pixi-vn/canvas` directly
(which would close an import cycle, since `canvas` depends on `tickers`).

###### removeVariable [#removevariable-1]

(`prefix`, `key`) => `void`

This function removes a variable.

###### restoreGameStepState [#restoregamestepstate-1]

(`state`, `navigate`) => `Promise`\<`void`>

This function restores the game step state.

If your game engine does not have a history of steps, you can return a resolved promise.

###### setFlag [#setflag-1]

(`name`, `value`) => `void`

This function sets the value of a flag.

###### setStepCounter [#setstepcounter]

(`value`) => `void`

This function sets the current step counter.

If your game engine does not have a history of steps, you can not set the step counter.

###### setVariable [#setvariable-1]

(`prefix`, `key`, `value`) => `void`

This function sets the value of a variable.

###### addHistoryItem [#addhistoryitem-1]

#### Returns [#returns-29]

`void`

***

### processNavigationRequests() [#processnavigationrequests-1]

\> `static` **processNavigationRequests**(`props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/GameUnifier.ts:394](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L394)

This function processes the pending navigation requests (continue/back).

#### Parameters [#parameters-7]

##### props [#props]

`any`

#### Returns [#returns-30]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

#### Throws [#throws-4]

when `Game.init()` has not been called yet.

***

### removeOnError() [#removeonerror]

\> `static` **removeOnError**(`handler`): `void`

Defined in: [src/core/GameUnifier.ts:543](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L543)

#### Parameters [#parameters-8]

##### handler [#handler-2]

[`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)

#### Returns [#returns-31]

`void`

***

### removeOnPreContinue() [#removeonprecontinue]

\> `static` **removeOnPreContinue**(`handler`): `void`

Defined in: [src/core/GameUnifier.ts:306](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L306)

#### Parameters [#parameters-9]

##### handler [#handler-3]

() => `void` | `Promise`\<`void`>

#### Returns [#returns-32]

`void`

***

### runOnError() [#runonerror]

\> `static` **runOnError**(`error`, `props`): `Promise`\<`void`>

Defined in: [src/core/GameUnifier.ts:551](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/GameUnifier.ts#L551)

#### Parameters [#parameters-10]

##### error [#error]

`unknown`

##### props [#props-1]

`any`

#### Returns [#returns-33]

`Promise`\<`void`>


# Class: GameWorkerManager (/pixi-vn/index/classes/GameWorkerManager)



Defined in: [src/worker/GameWorkerManager.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L26)

Optional integration point for offloading Pixi'VN's own heavy, pure (no DOM/PixiJS/audio)
computations to a Worker the game project registers. Pixi'VN never creates a Worker itself
and works exactly as before if none is registered - this is opt-in, not a requirement, so
projects that can't or don't want to use Workers (SSR, certain embeds, ...) are unaffected.

The game project owns the `Worker` instance (so it controls the bundler-specific `new
Worker(new URL(...), { type: "module" })` call, any CSP/nonce concerns, and whether it exists
at all) and just needs its `onmessage` wired to [handleGameWorkerMessage](/pixi-vn/index/functions/handleGameWorkerMessage) - see that
function's doc comment for the worker-side half of this.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new GameWorkerManager**(): `GameWorkerManager`

#### Returns [#returns]

`GameWorkerManager`

## Accessors [#accessors]

### isAvailable [#isavailable]

#### Get Signature [#get-signature]

\> **get** `static` **isAvailable**(): `boolean`

Defined in: [src/worker/GameWorkerManager.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L31)

##### Returns [#returns-1]

`boolean`

## Methods [#methods]

### clone() [#clone]

\> `static` **clone**\<`T`>(`value`): `Promise`\<`T`>

Defined in: [src/worker/GameWorkerManager.ts:108](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L108)

Deep-clones `value` (JSON round-trip, matching `createExportableElement`) on the registered worker.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `object`

#### Parameters [#parameters]

##### value [#value]

`T`

#### Returns [#returns-2]

`Promise`\<`T`>

***

### custom() [#custom]

\> `static` **custom**\<`TResult`>(`kind`, `payload`): `Promise`\<`TResult`>

Defined in: [src/worker/GameWorkerManager.ts:118](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L118)

Runs the handler a third-party library registered for `kind` (see
`registerGameWorkerHandler`) on the registered worker, passing it `payload`. Lets a
library built on top of Pixi'VN share this same worker instead of needing one of its own -
see that function's doc comment for the worker-side half of this.

#### Type Parameters [#type-parameters-1]

##### TResult [#tresult]

`TResult` = `unknown`

#### Parameters [#parameters-1]

##### kind [#kind]

`string`

##### payload [#payload]

`unknown`

#### Returns [#returns-3]

`Promise`\<`TResult`>

***

### diff() [#diff]

\> `static` **diff**(`before`, `after`): `Promise`\<`Difference`\[]>

Defined in: [src/worker/GameWorkerManager.ts:103](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L103)

Computes the `microdiff` difference between `before` and `after` on the registered worker.

#### Parameters [#parameters-2]

##### before [#before]

`object`

##### after [#after]

`object`

#### Returns [#returns-4]

`Promise`\<`Difference`\[]>

***

### register() [#register]

\> `static` **register**(`worker`): `void`

Defined in: [src/worker/GameWorkerManager.ts:40](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L40)

Registers the Worker Pixi'VN may use for eligible heavy computations. Replaces any
previously registered worker (its still-pending requests are rejected, never left
hanging).

#### Parameters [#parameters-3]

##### worker [#worker]

`Worker`

#### Returns [#returns-5]

`void`

***

### restoreDiff() [#restorediff]

\> `static` **restoreDiff**\<`T`>(`state`, `diff`): `Promise`\<`T`>

Defined in: [src/worker/GameWorkerManager.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L98)

Applies `diff` to `state` on the registered worker (see `restoreDiffChanges`).

#### Type Parameters [#type-parameters-2]

##### T [#t-1]

`T` *extends* `object`

#### Parameters [#parameters-4]

##### state [#state]

`T`

##### diff [#diff-1]

`Difference`\[]

#### Returns [#returns-6]

`Promise`\<`T`>

***

### unregister() [#unregister]

\> `static` **unregister**(): `void`

Defined in: [src/worker/GameWorkerManager.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerManager.ts#L47)

Stops using the registered worker (does not terminate it - the caller owns its lifecycle).

#### Returns [#returns-7]

`void`


# Class: HistoryManagerStatic (/pixi-vn/index/classes/HistoryManagerStatic)



Defined in: [src/history/HistoryManagerStatic.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L16)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new HistoryManagerStatic**(): `HistoryManagerStatic`

#### Returns [#returns]

`HistoryManagerStatic`

## Properties [#properties]

### \_diffHistory [#_diffhistory]

\> `static` **\_diffHistory**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, `Difference`\[]>

Defined in: [src/history/HistoryManagerStatic.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L17)

***

### \_narrationHistory [#_narrationhistory]

\> `static` **\_narrationHistory**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory)>

Defined in: [src/history/HistoryManagerStatic.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L21)

***

### \_originalStepData [#_originalstepdata]

\> `static` **\_originalStepData**: `GameStepState` | `undefined` = `undefined`

Defined in: [src/history/HistoryManagerStatic.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L24)

***

### \_stepsInfoHistory [#_stepsinfohistory]

\> `static` **\_stepsInfoHistory**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, `Omit`\<[`HistoryStep`](/pixi-vn/index/interfaces/HistoryStep), `"diff"`>>

Defined in: [src/history/HistoryManagerStatic.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L20)

***

### goBackMode [#gobackmode]

\> `static` **goBackMode**: [`HistoryGoBackModeType`](/pixi-vn/index/type-aliases/HistoryGoBackModeType) = `"step"`

Defined in: [src/history/HistoryManagerStatic.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L23)

***

### stepLimitSaved [#steplimitsaved]

\> `static` **stepLimitSaved**: `number` = `20`

Defined in: [src/history/HistoryManagerStatic.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L22)

## Accessors [#accessors]

### originalStepData [#originalstepdata]

#### Get Signature [#get-signature]

\> **get** `static` **originalStepData**(): `GameStepState`

Defined in: [src/history/HistoryManagerStatic.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L25)

##### Returns [#returns-1]

`GameStepState`

#### Set Signature [#set-signature]

\> **set** `static` **originalStepData**(`value`): `void`

Defined in: [src/history/HistoryManagerStatic.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L55)

##### Parameters [#parameters]

###### value [#value]

`GameStepState`

##### Returns [#returns-2]

`void`


# Class: ImageContainer (/pixi-vn/index/classes/ImageContainer)



Defined in: [src/canvas/components/ImageContainer.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L28)

This class is a extension of the [Container](/pixi-vn/index/classes/Container), it has the same properties and methods,
but this container is composed only of [ImageSprite](/pixi-vn/index/classes/ImageSprite) and introduces the [load](#load) functionality

## Example [#example]

```ts
 const liamBodyImageUrl = 'https://example.com/assets/liam/body.png';
 const liamHeadImageUrl = 'https://example.com/assets/liam/head.png';
 const container = new ImageContainer(undefined, [liamBodyImageUrl, liamHeadImageUrl]);
 await container.load()
 canvas.add(container);
```

## Extends [#extends]

* [`Container`](/pixi-vn/index/classes/Container)\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite), [`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ImageContainer**(`options?`, `textureAliases?`): `ImageContainer`

Defined in: [src/canvas/components/ImageContainer.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L33)

#### Parameters [#parameters]

##### options? [#options]

[`ImageContainerOptions`](/pixi-vn/index/interfaces/ImageContainerOptions)\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>>

The options for the component.

##### textureAliases? [#texturealiases]

`string`\[]

An array of image URLs or paths. If you have initialized the "asset matrix", you can use the alias of the texture.

#### Returns [#returns]

`ImageContainer`

#### Overrides [#overrides]

[`Container`](/pixi-vn/index/classes/Container).[`constructor`](/pixi-vn/index/classes/Container#constructor)

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

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

[`Container`](/pixi-vn/index/classes/Container).[`__devtoolIgnore`](/pixi-vn/index/classes/Container#__devtoolignore)

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

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

[`Container`](/pixi-vn/index/classes/Container).[`__devtoolIgnoreChildren`](/pixi-vn/index/classes/Container#__devtoolignorechildren)

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

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

[`Container`](/pixi-vn/index/classes/Container).[`__devtoolLocked`](/pixi-vn/index/classes/Container#__devtoollocked)

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

[`Container`](/pixi-vn/index/classes/Container).[`_cx`](/pixi-vn/index/classes/Container#_cx)

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

[`Container`](/pixi-vn/index/classes/Container).[`_cy`](/pixi-vn/index/classes/Container#_cy)

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

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

[`Container`](/pixi-vn/index/classes/Container).[`_pivot`](/pixi-vn/index/classes/Container#_pivot)

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

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

[`Container`](/pixi-vn/index/classes/Container).[`_position`](/pixi-vn/index/classes/Container#_position)

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

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

[`Container`](/pixi-vn/index/classes/Container).[`_scale`](/pixi-vn/index/classes/Container#_scale)

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

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

[`Container`](/pixi-vn/index/classes/Container).[`_skew`](/pixi-vn/index/classes/Container#_skew)

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

[`Container`](/pixi-vn/index/classes/Container).[`_sx`](/pixi-vn/index/classes/Container#_sx)

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

[`Container`](/pixi-vn/index/classes/Container).[`_sy`](/pixi-vn/index/classes/Container#_sy)

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`_zIndex`](/pixi-vn/index/classes/Container#_zindex)

***

### accessible? [#accessible]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessible`](/pixi-vn/index/classes/Container#accessible)

***

### accessibleChildren? [#accessiblechildren]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessibleChildren`](/pixi-vn/index/classes/Container#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessibleHint`](/pixi-vn/index/classes/Container#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessiblePointerEvents`](/pixi-vn/index/classes/Container#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessibleText`](/pixi-vn/index/classes/Container#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessibleTitle`](/pixi-vn/index/classes/Container#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

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

[`Container`](/pixi-vn/index/classes/Container).[`accessibleType`](/pixi-vn/index/classes/Container#accessibletype)

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:10

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`allowChildren`](/pixi-vn/index/classes/Container#allowchildren)

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`boundsArea`](/pixi-vn/index/classes/Container#boundsarea)

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

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

[`Container`](/pixi-vn/index/classes/Container).[`cacheAsBitmap`](/pixi-vn/index/classes/Container#cacheasbitmap)

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

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

[`Container`](/pixi-vn/index/classes/Container).[`cacheAsTexture`](/pixi-vn/index/classes/Container#cacheastexture)

***

### children [#children]

\> `readonly` **children**: [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

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

[`Container`](/pixi-vn/index/classes/Container).[`children`](/pixi-vn/index/classes/Container#children)

***

### cullable? [#cullable]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

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

[`Container`](/pixi-vn/index/classes/Container).[`cullable`](/pixi-vn/index/classes/Container#cullable)

***

### cullableChildren? [#cullablechildren]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

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

[`Container`](/pixi-vn/index/classes/Container).[`cullableChildren`](/pixi-vn/index/classes/Container#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`cullArea`](/pixi-vn/index/classes/Container#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

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

[`Container`](/pixi-vn/index/classes/Container).[`cursor`](/pixi-vn/index/classes/Container#cursor)

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`depthOfChildModified`](/pixi-vn/index/classes/Container#depthofchildmodified)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

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

[`Container`](/pixi-vn/index/classes/Container).[`destroyed`](/pixi-vn/index/classes/Container#destroyed)

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

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

[`Container`](/pixi-vn/index/classes/Container).[`effects`](/pixi-vn/index/classes/Container#effects)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

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

[`Container`](/pixi-vn/index/classes/Container).[`eventMode`](/pixi-vn/index/classes/Container#eventmode)

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

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

[`Container`](/pixi-vn/index/classes/Container).[`filterArea`](/pixi-vn/index/classes/Container#filterarea)

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`globalDisplayStatus`](/pixi-vn/index/classes/Container#globaldisplaystatus)

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`groupAlpha`](/pixi-vn/index/classes/Container#groupalpha)

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`groupBlendMode`](/pixi-vn/index/classes/Container#groupblendmode)

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`groupColor`](/pixi-vn/index/classes/Container#groupcolor)

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`groupColorAlpha`](/pixi-vn/index/classes/Container#groupcoloralpha)

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

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

[`Container`](/pixi-vn/index/classes/Container).[`groupTransform`](/pixi-vn/index/classes/Container#grouptransform)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

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

[`Container`](/pixi-vn/index/classes/Container).[`hitArea`](/pixi-vn/index/classes/Container#hitarea)

***

### interactive? [#interactive]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

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

[`Container`](/pixi-vn/index/classes/Container).[`interactive`](/pixi-vn/index/classes/Container#interactive)

***

### interactiveChildren? [#interactivechildren]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

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

[`Container`](/pixi-vn/index/classes/Container).[`interactiveChildren`](/pixi-vn/index/classes/Container#interactivechildren)

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

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

[`Container`](/pixi-vn/index/classes/Container).[`isCachedAsTexture`](/pixi-vn/index/classes/Container#iscachedastexture)

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

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

[`Container`](/pixi-vn/index/classes/Container).[`isInteractive`](/pixi-vn/index/classes/Container#isinteractive)

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`layerParentId`](/pixi-vn/index/classes/Container#layerparentid)

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`localAlpha`](/pixi-vn/index/classes/Container#localalpha)

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`localBlendMode`](/pixi-vn/index/classes/Container#localblendmode)

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`localColor`](/pixi-vn/index/classes/Container#localcolor)

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

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

[`Container`](/pixi-vn/index/classes/Container).[`localDisplayStatus`](/pixi-vn/index/classes/Container#localdisplaystatus)

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

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

[`Container`](/pixi-vn/index/classes/Container).[`localTransform`](/pixi-vn/index/classes/Container#localtransform)

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

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

[`Container`](/pixi-vn/index/classes/Container).[`mask`](/pixi-vn/index/classes/Container#mask)

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`name`](/pixi-vn/index/classes/Container#name)

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onclick`](/pixi-vn/index/classes/Container#onclick)

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Container.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L93)

ListenerExtension

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

[`Container`](/pixi-vn/index/classes/Container).[`onEventsHandlers`](/pixi-vn/index/classes/Container#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

[`Container`](/pixi-vn/index/classes/Container).[`onglobalmousemove`](/pixi-vn/index/classes/Container#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

[`Container`](/pixi-vn/index/classes/Container).[`onglobalpointermove`](/pixi-vn/index/classes/Container#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

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

[`Container`](/pixi-vn/index/classes/Container).[`onglobaltouchmove`](/pixi-vn/index/classes/Container#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmousedown`](/pixi-vn/index/classes/Container#onmousedown)

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseenter`](/pixi-vn/index/classes/Container#onmouseenter)

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseleave`](/pixi-vn/index/classes/Container#onmouseleave)

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmousemove`](/pixi-vn/index/classes/Container#onmousemove)

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseout`](/pixi-vn/index/classes/Container#onmouseout)

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseover`](/pixi-vn/index/classes/Container#onmouseover)

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseup`](/pixi-vn/index/classes/Container#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onmouseupoutside`](/pixi-vn/index/classes/Container#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointercancel`](/pixi-vn/index/classes/Container#onpointercancel)

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerdown`](/pixi-vn/index/classes/Container#onpointerdown)

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerenter`](/pixi-vn/index/classes/Container#onpointerenter)

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerleave`](/pixi-vn/index/classes/Container#onpointerleave)

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointermove`](/pixi-vn/index/classes/Container#onpointermove)

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerout`](/pixi-vn/index/classes/Container#onpointerout)

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerover`](/pixi-vn/index/classes/Container#onpointerover)

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointertap`](/pixi-vn/index/classes/Container#onpointertap)

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerup`](/pixi-vn/index/classes/Container#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onpointerupoutside`](/pixi-vn/index/classes/Container#onpointerupoutside)

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onrightclick`](/pixi-vn/index/classes/Container#onrightclick)

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onrightdown`](/pixi-vn/index/classes/Container#onrightdown)

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onrightup`](/pixi-vn/index/classes/Container#onrightup)

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onrightupoutside`](/pixi-vn/index/classes/Container#onrightupoutside)

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontap`](/pixi-vn/index/classes/Container#ontap)

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontouchcancel`](/pixi-vn/index/classes/Container#ontouchcancel)

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontouchend`](/pixi-vn/index/classes/Container#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontouchendoutside`](/pixi-vn/index/classes/Container#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontouchmove`](/pixi-vn/index/classes/Container#ontouchmove)

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`ontouchstart`](/pixi-vn/index/classes/Container#ontouchstart)

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

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

[`Container`](/pixi-vn/index/classes/Container).[`onwheel`](/pixi-vn/index/classes/Container#onwheel)

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

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

[`Container`](/pixi-vn/index/classes/Container).[`parent`](/pixi-vn/index/classes/Container#parent)

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

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

[`Container`](/pixi-vn/index/classes/Container).[`parentRenderLayer`](/pixi-vn/index/classes/Container#parentrenderlayer)

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_IMAGE_CONTAINER_ID`

Defined in: [src/canvas/components/ImageContainer.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L69)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Overrides [#overrides-1]

[`Container`](/pixi-vn/index/classes/Container).[`pixivnId`](/pixi-vn/index/classes/Container#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

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

[`Container`](/pixi-vn/index/classes/Container).[`relativeGroupTransform`](/pixi-vn/index/classes/Container#relativegrouptransform)

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:800

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`renderPipeId`](/pixi-vn/index/classes/Container#renderpipeid)

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

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

[`Container`](/pixi-vn/index/classes/Container).[`sortChildren`](/pixi-vn/index/classes/Container#sortchildren)

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

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

[`Container`](/pixi-vn/index/classes/Container).[`tabIndex`](/pixi-vn/index/classes/Container#tabindex)

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

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

[`Container`](/pixi-vn/index/classes/Container).[`uid`](/pixi-vn/index/classes/Container#uid)

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

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

[`Container`](/pixi-vn/index/classes/Container).[`updateCacheTexture`](/pixi-vn/index/classes/Container#updatecachetexture)

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

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

[`Container`](/pixi-vn/index/classes/Container).[`updateTick`](/pixi-vn/index/classes/Container#updatetick)

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

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

[`Container`](/pixi-vn/index/classes/Container).[`prefixed`](/pixi-vn/index/classes/Container#prefixed)

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Container.ts:160](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L160)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:148](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L148)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Container`](/pixi-vn/index/classes/Container).[`align`](/pixi-vn/index/classes/Container#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`alpha`](/pixi-vn/index/classes/Container#alpha)

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `PointData`

Defined in: [src/canvas/components/Container.ts:119](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L119)

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-66]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Returns [#returns-10]

`PointData`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:124](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L124)

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-67]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

#### Example [#example-68]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

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

[`Container`](/pixi-vn/index/classes/Container).[`anchor`](/pixi-vn/index/classes/Container#anchor)

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-69]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`angle`](/pixi-vn/index/classes/Container#angle)

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-70]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`blendMode`](/pixi-vn/index/classes/Container#blendmode)

***

### filters [#filters]

#### Get Signature [#get-signature-5]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-71]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-16]

Filter For filter base class

##### Returns [#returns-16]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-72]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-17]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-17]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`filters`](/pixi-vn/index/classes/Container#filters)

***

### haveEmptyTexture [#haveemptytexture]

#### Get Signature [#get-signature-6]

\> **get** **haveEmptyTexture**(): `boolean`

Defined in: [src/canvas/components/ImageContainer.ts:109](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L109)

Check if there is a child with the empty texture.

##### Returns [#returns-18]

`boolean`

A boolean that is true if there is a child with the empty texture.

***

### height [#height]

#### Get Signature [#get-signature-7]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-73]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-19]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-20]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`height`](/pixi-vn/index/classes/Container#height)

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-8]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-21]

`boolean`

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

[`Container`](/pixi-vn/index/classes/Container).[`isRenderable`](/pixi-vn/index/classes/Container#isrenderable)

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-9]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-22]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-23]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`isRenderGroup`](/pixi-vn/index/classes/Container#isrendergroup)

***

### loadIsStarted [#loadisstarted]

#### Get Signature [#get-signature-10]

\> **get** **loadIsStarted**(): `boolean`

Defined in: [src/canvas/components/ImageContainer.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L71)

##### Returns [#returns-24]

`boolean`

***

### memory [#memory]

#### Get Signature [#get-signature-11]

\> **get** **memory**(): [`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)

Defined in: [src/canvas/components/ImageContainer.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L56)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-25]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)

#### Overrides [#overrides-2]

[`Container`](/pixi-vn/index/classes/Container).[`memory`](/pixi-vn/index/classes/Container#memory-1)

***

### origin [#origin]

#### Get Signature [#get-signature-12]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-74]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-26]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-27]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`origin`](/pixi-vn/index/classes/Container#origin)

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-13]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Container.ts:231](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L231)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-28]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:219](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L219)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-29]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Container`](/pixi-vn/index/classes/Container).[`percentagePosition`](/pixi-vn/index/classes/Container#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-14]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Container.ts:245](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L245)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-30]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Container.ts:237](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L237)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-31]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Container`](/pixi-vn/index/classes/Container).[`percentageX`](/pixi-vn/index/classes/Container#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-15]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Container.ts:256](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L256)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-32]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Container.ts:248](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L248)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-33]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Container`](/pixi-vn/index/classes/Container).[`percentageY`](/pixi-vn/index/classes/Container#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-16]

\> **get** **pivot**(): `ObservablePoint`

Defined in: [src/canvas/components/Container.ts:137](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L137)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-75]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-34]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L140)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-76]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-3]

4.0.0

##### Parameters [#parameters-14]

###### value [#value-10]

`ObservablePoint`

##### Returns [#returns-35]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`pivot`](/pixi-vn/index/classes/Container#pivot)

***

### position [#position]

#### Get Signature [#get-signature-17]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Container.ts:323](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L323)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-77]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Returns [#returns-36]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:326](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L326)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-78]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-5]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-37]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`position`](/pixi-vn/index/classes/Container#position)

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-18]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Container.ts:267](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L267)

##### Returns [#returns-38]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:277](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L277)

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-39]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`positionInfo`](/pixi-vn/index/classes/Container#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-19]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Container.ts:259](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L259)

##### Returns [#returns-40]

`"pixel"` | `"percentage"` | `"align"`

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

[`Container`](/pixi-vn/index/classes/Container).[`positionType`](/pixi-vn/index/classes/Container#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-20]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-79]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-18]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-41]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-42]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`renderable`](/pixi-vn/index/classes/Container#renderable)

***

### rotation [#rotation]

#### Get Signature [#get-signature-21]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-80]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-43]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-44]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`rotation`](/pixi-vn/index/classes/Container#rotation)

***

### scale [#scale]

#### Get Signature [#get-signature-22]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-81]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-6]

4.0.0

##### Returns [#returns-45]

`ObservablePoint`

#### Set Signature [#set-signature-17]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-19]

###### value [#value-15]

`string` | `number` | `PointData`

##### Returns [#returns-46]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`scale`](/pixi-vn/index/classes/Container#scale)

***

### skew [#skew]

#### Get Signature [#get-signature-23]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-82]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-7]

4.0.0

##### Default [#default-55]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-47]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-20]

###### value [#value-16]

`PointData`

##### Returns [#returns-48]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`skew`](/pixi-vn/index/classes/Container#skew)

***

### texture [#texture]

#### Get Signature [#get-signature-24]

\> **get** **texture**(): `Texture`\<`TextureSource`\<`any`>>

Defined in: [src/canvas/components/ImageContainer.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L98)

The texture of the first child.
If there is no child, it returns a new [Texture](/pixi-vn/index/variables/Texture).

##### Returns [#returns-49]

`Texture`\<`TextureSource`\<`any`>>

***

### tint [#tint]

#### Get Signature [#get-signature-25]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-83]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-56]

```ts
0xFFFFFF
```

##### See [#see-19]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-50]

`number`

#### Set Signature [#set-signature-19]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-21]

###### value [#value-17]

`ColorSource`

##### Returns [#returns-51]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`tint`](/pixi-vn/index/classes/Container#tint)

***

### visible [#visible]

#### Get Signature [#get-signature-26]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-84]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-57]

```ts
true
```

##### See [#see-20]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-52]

`boolean`

#### Set Signature [#set-signature-20]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-22]

###### value [#value-18]

`boolean`

##### Returns [#returns-53]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`visible`](/pixi-vn/index/classes/Container#visible)

***

### width [#width]

#### Get Signature [#get-signature-27]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-85]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-54]

`number`

#### Set Signature [#set-signature-21]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-23]

###### value [#value-19]

`number`

##### Returns [#returns-55]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`width`](/pixi-vn/index/classes/Container#width)

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-28]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-86]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-21]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-56]

`Matrix`

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

[`Container`](/pixi-vn/index/classes/Container).[`worldTransform`](/pixi-vn/index/classes/Container#worldtransform)

***

### x [#x-2]

#### Get Signature [#get-signature-29]

\> **get** **x**(): `number`

Defined in: [src/canvas/components/Container.ts:331](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L331)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-87]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-57]

`number`

#### Set Signature [#set-signature-22]

\> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L334)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-88]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-24]

###### value [#value-20]

`number`

##### Returns [#returns-58]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`x`](/pixi-vn/index/classes/Container#x)

***

### xAlign [#xalign]

#### Get Signature [#get-signature-30]

\> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Container.ts:188](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L188)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-59]

`number`

#### Set Signature [#set-signature-23]

\> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L180)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-25]

###### value [#value-21]

`number`

##### Returns [#returns-60]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Container`](/pixi-vn/index/classes/Container).[`xAlign`](/pixi-vn/index/classes/Container#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-31]

\> **get** **y**(): `number`

Defined in: [src/canvas/components/Container.ts:339](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L339)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-89]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-61]

`number`

#### Set Signature [#set-signature-24]

\> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:342](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L342)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-90]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-62]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`y`](/pixi-vn/index/classes/Container#y)

***

### yAlign [#yalign]

#### Get Signature [#get-signature-32]

\> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Container.ts:207](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L207)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-63]

`number`

#### Set Signature [#set-signature-25]

\> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Container.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L199)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-64]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Container`](/pixi-vn/index/classes/Container).[`yAlign`](/pixi-vn/index/classes/Container#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-28]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-65]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`_getGlobalBoundsRecursive`](/pixi-vn/index/classes/Container#_getglobalboundsrecursive)

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters]

##### U [#u]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

#### Parameters [#parameters-29]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-66]

`U`\[`0`]

The first child that was added

#### Example [#example-91]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-22]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

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

[`Container`](/pixi-vn/index/classes/Container).[`addChild`](/pixi-vn/index/classes/Container#addchild)

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-1]

##### U [#u-1]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-30]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-67]

`U`

The child that was added

#### Example [#example-92]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-23]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

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

[`Container`](/pixi-vn/index/classes/Container).[`addChildAt`](/pixi-vn/index/classes/Container#addchildat)

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-2]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-31]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-68]

`void`

##### Example [#example-93]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

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

[`Container`](/pixi-vn/index/classes/Container).[`addEventListener`](/pixi-vn/index/classes/Container#addeventlistener)

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-32]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-69]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`addEventListener`](/pixi-vn/index/classes/Container#addeventlistener)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-3]

##### T [#t]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-33]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-70]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`addListener`](/pixi-vn/index/classes/Container#addlistener)

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-34]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-71]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`collectRenderables`](/pixi-vn/index/classes/Container#collectrenderables)

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:30

**`Internal`**

Collects renderables using a simple method, suitable for containers marked as simple.
This method iterates over the container's children and adds their renderables to the instruction set.

#### Parameters [#parameters-35]

##### instructionSet [#instructionset-1]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-1]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-72]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`collectRenderablesSimple`](/pixi-vn/index/classes/Container#collectrenderablessimple)

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-36]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-73]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`collectRenderablesWithEffects`](/pixi-vn/index/classes/Container#collectrenderableswitheffects)

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1343

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling `destroy`.

#### Parameters [#parameters-37]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-74]

`void`

#### Example [#example-94]

```ts
container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });
```

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

[`Container`](/pixi-vn/index/classes/Container).[`destroy`](/pixi-vn/index/classes/Container#destroy)

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-75]

`void`

#### Advanced [#advanced-9]

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

[`Container`](/pixi-vn/index/classes/Container).[`disableRenderGroup`](/pixi-vn/index/classes/Container#disablerendergroup)

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-38]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-76]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-95]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`dispatchEvent`](/pixi-vn/index/classes/Container#dispatchevent)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-1]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-39]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>> & `AnyEvent`>\[`Extract`\<`T`, keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>>]

#### Returns [#returns-77]

`boolean`

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

[`Container`](/pixi-vn/index/classes/Container).[`emit`](/pixi-vn/index/classes/Container#emit)

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-78]

`void`

#### Advanced [#advanced-10]

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

[`Container`](/pixi-vn/index/classes/Container).[`enableRenderGroup`](/pixi-vn/index/classes/Container#enablerendergroup)

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-79]

(keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>)\[]

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

[`Container`](/pixi-vn/index/classes/Container).[`eventNames`](/pixi-vn/index/classes/Container#eventnames)

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-40]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-1]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-80]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-96]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-24]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

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

[`Container`](/pixi-vn/index/classes/Container).[`getBounds`](/pixi-vn/index/classes/Container#getbounds)

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-5]

##### U [#u-2]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-41]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-81]

`U`

The child at the given index

#### Example [#example-97]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-25]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

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

[`Container`](/pixi-vn/index/classes/Container).[`getChildAt`](/pixi-vn/index/classes/Container#getchildat)

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-42]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-82]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-98]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-26]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

[`Container`](/pixi-vn/index/classes/Container).[`getChildByLabel`](/pixi-vn/index/classes/Container#getchildbylabel)

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-43]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-83]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-27]

Container#getChildByLabel

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

[`Container`](/pixi-vn/index/classes/Container).[`getChildByName`](/pixi-vn/index/classes/Container#getchildbyname)

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-44]

##### child [#child-1]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)

The Container instance to identify

#### Returns [#returns-84]

`number`

The index position of the child container

#### Example [#example-99]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-28]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

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

[`Container`](/pixi-vn/index/classes/Container).[`getChildIndex`](/pixi-vn/index/classes/Container#getchildindex)

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-45]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-85]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-100]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-29]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

[`Container`](/pixi-vn/index/classes/Container).[`getChildrenByLabel`](/pixi-vn/index/classes/Container#getchildrenbylabel)

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-46]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-2]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-86]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

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

[`Container`](/pixi-vn/index/classes/Container).[`getFastGlobalBounds`](/pixi-vn/index/classes/Container#getfastglobalbounds)

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-47]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-87]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-101]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`getGlobalAlpha`](/pixi-vn/index/classes/Container#getglobalalpha)

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-48]

##### point? [#point]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-88]

`Point`

The updated point

#### Example [#example-102]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-30]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

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

[`Container`](/pixi-vn/index/classes/Container).[`getGlobalPosition`](/pixi-vn/index/classes/Container#getglobalposition)

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-49]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-89]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-103]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`getGlobalTint`](/pixi-vn/index/classes/Container#getglobaltint)

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-50]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-90]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`getGlobalTransform`](/pixi-vn/index/classes/Container#getglobaltransform)

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-91]

`Bounds`

The bounding area

#### Example [#example-105]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-31]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

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

[`Container`](/pixi-vn/index/classes/Container).[`getLocalBounds`](/pixi-vn/index/classes/Container#getlocalbounds)

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-51]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-92]

`Size`

The size of the container.

#### Example [#example-106]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

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

[`Container`](/pixi-vn/index/classes/Container).[`getSize`](/pixi-vn/index/classes/Container#getsize)

***

### importChildren() [#importchildren]

\> `protected` **importChildren**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/Container.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L83)

#### Parameters [#parameters-52]

##### value [#value-24]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)

#### Returns [#returns-93]

`Promise`\<`void`>

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

[`Container`](/pixi-vn/index/classes/Container).[`importChildren`](/pixi-vn/index/classes/Container#importchildren)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-53]

##### event [#event-2]

keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Returns [#returns-94]

`number`

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

[`Container`](/pixi-vn/index/classes/Container).[`listenerCount`](/pixi-vn/index/classes/Container#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-2]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-54]

##### event [#event-3]

`T`

#### Returns [#returns-95]

(...`args`) => `void`\[]

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

[`Container`](/pixi-vn/index/classes/Container).[`listeners`](/pixi-vn/index/classes/Container#listeners)

***

### load() [#load]

\> **load**(): `Promise`\<`void`>

Defined in: [src/canvas/components/ImageContainer.ts:78](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L78)

Load the children images.

#### Returns [#returns-96]

`Promise`\<`void`>

A promise that resolves when the images are loaded.

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-7]

##### T [#t-3]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-55]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-97]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`off`](/pixi-vn/index/classes/Container#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Container.ts:94](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L94)

Add a listener for a given event.

#### Type Parameters [#type-parameters-8]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<C>

#### Parameters [#parameters-56]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-98]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`on`](/pixi-vn/index/classes/Container#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-5]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-57]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-99]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`once`](/pixi-vn/index/classes/Container#once)

***

### reloadAnchor() [#reloadanchor]

\> `protected` **reloadAnchor**(): `void`

Defined in: [src/canvas/components/Container.ts:132](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L132)

#### Returns [#returns-100]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`reloadAnchor`](/pixi-vn/index/classes/Container#reloadanchor)

***

### reloadPosition() [#reloadposition]

\> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Container.ts:286](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Container.ts#L286)

#### Returns [#returns-101]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`reloadPosition`](/pixi-vn/index/classes/Container#reloadposition)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-58]

##### event? [#event-7]

keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Returns [#returns-102]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`removeAllListeners`](/pixi-vn/index/classes/Container#removealllisteners)

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-10]

##### U [#u-3]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

#### Parameters [#parameters-59]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-103]

`U`\[`0`]

The first child that was removed

#### Example [#example-107]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-32]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

[`Container`](/pixi-vn/index/classes/Container).[`removeChild`](/pixi-vn/index/classes/Container#removechild)

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-11]

##### U [#u-4]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-60]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-104]

`U`

The child that was removed

#### Example [#example-108]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-33]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

[`Container`](/pixi-vn/index/classes/Container).[`removeChildAt`](/pixi-vn/index/classes/Container#removechildat)

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-61]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-105]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

List of removed children

#### Example [#example-109]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-34]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

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

[`Container`](/pixi-vn/index/classes/Container).[`removeChildren`](/pixi-vn/index/classes/Container#removechildren)

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-12]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-62]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-106]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`removeEventListener`](/pixi-vn/index/classes/Container#removeeventlistener)

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-63]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-107]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`removeEventListener`](/pixi-vn/index/classes/Container#removeeventlistener)

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-108]

`void`

#### Example [#example-110]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-35]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

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

[`Container`](/pixi-vn/index/classes/Container).[`removeFromParent`](/pixi-vn/index/classes/Container#removefromparent)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-13]

##### T [#t-6]

`T` *extends* keyof AnyEvent | keyof ContainerEvents\<ImageSprite\<ImageSpriteMemory>>

#### Parameters [#parameters-64]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-109]

`this`

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

[`Container`](/pixi-vn/index/classes/Container).[`removeListener`](/pixi-vn/index/classes/Container#removelistener)

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-14]

##### U [#u-5]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

#### Parameters [#parameters-65]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-110]

`U`\[`0`]

The first child that was reparented

#### Example [#example-111]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-36]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

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

[`Container`](/pixi-vn/index/classes/Container).[`reparentChild`](/pixi-vn/index/classes/Container#reparentchild)

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-6]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-66]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-111]

`U`

The reparented child

#### Example [#example-112]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-37]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

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

[`Container`](/pixi-vn/index/classes/Container).[`reparentChildAt`](/pixi-vn/index/classes/Container#reparentchildat)

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-16]

##### U [#u-7]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

##### T [#t-7]

`T` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-67]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-112]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`replaceChild`](/pixi-vn/index/classes/Container#replacechild)

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-68]

##### child [#child-4]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-113]

`void`

#### Example [#example-113]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-38]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

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

[`Container`](/pixi-vn/index/classes/Container).[`setChildIndex`](/pixi-vn/index/classes/Container#setchildindex)

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-69]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-114]

`void`

#### Example [#example-114]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-39]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

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

[`Container`](/pixi-vn/index/classes/Container).[`setFromMatrix`](/pixi-vn/index/classes/Container#setfrommatrix)

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-70]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-115]

`void`

#### Example [#example-115]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-40]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

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

[`Container`](/pixi-vn/index/classes/Container).[`setMask`](/pixi-vn/index/classes/Container#setmask)

***

### setMemory() [#setmemory]

\> **setMemory**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/ImageContainer.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageContainer.ts#L63)

This method set the memory of the canvas element.

#### Parameters [#parameters-71]

##### value [#value-25]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)

#### Returns [#returns-116]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Overrides [#overrides-3]

[`Container`](/pixi-vn/index/classes/Container).[`setMemory`](/pixi-vn/index/classes/Container#setmemory)

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-72]

##### value [#value-26]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-117]

`void`

#### Example [#example-116]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

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

[`Container`](/pixi-vn/index/classes/Container).[`setSize`](/pixi-vn/index/classes/Container#setsize)

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-17]

##### U [#u-8]

`U` *extends* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

#### Parameters [#parameters-73]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-118]

`void`

#### Example [#example-117]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-41]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

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

[`Container`](/pixi-vn/index/classes/Container).[`swapChildren`](/pixi-vn/index/classes/Container#swapchildren)

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-18]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-74]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-1]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-119]

`P`

The global position

#### Example [#example-118]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-42]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

[`Container`](/pixi-vn/index/classes/Container).[`toGlobal`](/pixi-vn/index/classes/Container#toglobal)

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-19]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-75]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-2]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-120]

`P`

A point object representing the position in local space

#### Example [#example-119]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-43]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

[`Container`](/pixi-vn/index/classes/Container).[`toLocal`](/pixi-vn/index/classes/Container#tolocal)

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-121]

`void`

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

[`Container`](/pixi-vn/index/classes/Container).[`updateLocalTransform`](/pixi-vn/index/classes/Container#updatelocaltransform)

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-76]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-122]

`this`

This container, for chaining

#### Example [#example-120]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-44]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

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

[`Container`](/pixi-vn/index/classes/Container).[`updateTransform`](/pixi-vn/index/classes/Container#updatetransform)

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-77]

##### source [#source]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-123]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

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

[`Container`](/pixi-vn/index/classes/Container).[`mixin`](/pixi-vn/index/classes/Container#mixin)


# Class: ImageSprite<Memory> (/pixi-vn/index/classes/ImageSprite)



Defined in: [src/canvas/components/ImageSprite.ts:40](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L40)

This class is a extension of the [Sprite](/pixi-vn/index/classes/Sprite) class, it has the same properties and methods,
but it has some features that make texture management easier.
You need to use [load](#load) to show the image in the canvas.
This class is used for functions like [addImage](/pixi-vn/index/functions/addImage) and [showWithDissolve](/pixi-vn/index/functions/showWithDissolve).

## Examples [#examples]

```ts
let alien = new ImageSprite({
    anchor: { x: 0.5, y: 0.5 },
    x: 100,
    y: 100,
}, 'https://pixijs.com/assets/eggHead.png')
await alien.load()
canvas.add("alien", alien)
```

```ts
let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
alien.anchor.set(0.5);
alien.x = 100
alien.y = 100
await alien.load()
```

## Extends [#extends]

* [`Sprite`](/pixi-vn/index/classes/Sprite)\<`Memory`>

## Extended by [#extended-by]

* [`VideoSprite`](/pixi-vn/index/classes/VideoSprite)

## Type Parameters [#type-parameters]

### Memory [#memory]

`Memory` *extends* [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory) = [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ImageSprite**\<`Memory`>(`options?`, `textureAlias?`): `ImageSprite`\<`Memory`>

Defined in: [src/canvas/components/ImageSprite.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L55)

#### Parameters [#parameters]

##### options? [#options]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions) | `Omit`\<`Texture`\<`TextureSource`\<`any`>>, `"on"`>

The options for the component.

##### textureAlias? [#texturealias]

`string`

The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.

#### Returns [#returns]

`ImageSprite`\<`Memory`>

#### Overrides [#overrides]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`constructor`](/pixi-vn/index/classes/Sprite#constructor)

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`__devtoolIgnore`](/pixi-vn/index/classes/Sprite#__devtoolignore)

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`__devtoolIgnoreChildren`](/pixi-vn/index/classes/Sprite#__devtoolignorechildren)

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`__devtoolLocked`](/pixi-vn/index/classes/Sprite#__devtoollocked)

***

### \_anchor [#_anchor]

\> `readonly` **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:155

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_anchor`](/pixi-vn/index/classes/Sprite#_anchor)

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_bounds`](/pixi-vn/index/classes/Sprite#_bounds)

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_boundsDirty`](/pixi-vn/index/classes/Sprite#_boundsdirty)

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_cx`](/pixi-vn/index/classes/Sprite#_cx)

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_cy`](/pixi-vn/index/classes/Sprite#_cy)

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_gcData`](/pixi-vn/index/classes/Sprite#_gcdata)

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_gcLastUsed`](/pixi-vn/index/classes/Sprite#_gclastused)

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_gpuData`](/pixi-vn/index/classes/Sprite#_gpudata)

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_lastUsed`](/pixi-vn/index/classes/Sprite#_lastused)

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_pivot`](/pixi-vn/index/classes/Sprite#_pivot)

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_position`](/pixi-vn/index/classes/Sprite#_position)

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_roundPixels`](/pixi-vn/index/classes/Sprite#_roundpixels)

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_scale`](/pixi-vn/index/classes/Sprite#_scale)

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_skew`](/pixi-vn/index/classes/Sprite#_skew)

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_sx`](/pixi-vn/index/classes/Sprite#_sx)

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_sy`](/pixi-vn/index/classes/Sprite#_sy)

***

### \_texture [#_texture]

\> **\_texture**: `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:157

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_texture`](/pixi-vn/index/classes/Sprite#_texture)

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_zIndex`](/pixi-vn/index/classes/Sprite#_zindex)

***

### accessible? [#accessible]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessible`](/pixi-vn/index/classes/Sprite#accessible)

***

### accessibleChildren? [#accessiblechildren]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessibleChildren`](/pixi-vn/index/classes/Sprite#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessibleHint`](/pixi-vn/index/classes/Sprite#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessiblePointerEvents`](/pixi-vn/index/classes/Sprite#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessibleText`](/pixi-vn/index/classes/Sprite#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessibleTitle`](/pixi-vn/index/classes/Sprite#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`accessibleType`](/pixi-vn/index/classes/Sprite#accessibletype)

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`allowChildren`](/pixi-vn/index/classes/Sprite#allowchildren)

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`autoGarbageCollect`](/pixi-vn/index/classes/Sprite#autogarbagecollect)

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:153

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`batched`](/pixi-vn/index/classes/Sprite#batched)

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-7]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`boundsArea`](/pixi-vn/index/classes/Sprite#boundsarea)

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cacheAsBitmap`](/pixi-vn/index/classes/Sprite#cacheasbitmap)

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-8]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cacheAsTexture`](/pixi-vn/index/classes/Sprite#cacheastexture)

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`canBundle`](/pixi-vn/index/classes/Sprite#canbundle)

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-9]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`children`](/pixi-vn/index/classes/Sprite#children)

***

### cullable? [#cullable]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-10]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cullable`](/pixi-vn/index/classes/Sprite#cullable)

***

### cullableChildren? [#cullablechildren]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-11]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cullableChildren`](/pixi-vn/index/classes/Sprite#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-12]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cullArea`](/pixi-vn/index/classes/Sprite#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-13]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`cursor`](/pixi-vn/index/classes/Sprite#cursor)

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`depthOfChildModified`](/pixi-vn/index/classes/Sprite#depthofchildmodified)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-14]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`destroyed`](/pixi-vn/index/classes/Sprite#destroyed)

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`effects`](/pixi-vn/index/classes/Sprite#effects)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-15]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`eventMode`](/pixi-vn/index/classes/Sprite#eventmode)

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-16]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`filterArea`](/pixi-vn/index/classes/Sprite#filterarea)

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`globalDisplayStatus`](/pixi-vn/index/classes/Sprite#globaldisplaystatus)

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`groupAlpha`](/pixi-vn/index/classes/Sprite#groupalpha)

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`groupBlendMode`](/pixi-vn/index/classes/Sprite#groupblendmode)

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`groupColor`](/pixi-vn/index/classes/Sprite#groupcolor)

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`groupColorAlpha`](/pixi-vn/index/classes/Sprite#groupcoloralpha)

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`groupTransform`](/pixi-vn/index/classes/Sprite#grouptransform)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-17]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`hitArea`](/pixi-vn/index/classes/Sprite#hitarea)

***

### interactive? [#interactive]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-18]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`interactive`](/pixi-vn/index/classes/Sprite#interactive)

***

### interactiveChildren? [#interactivechildren]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-19]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`interactiveChildren`](/pixi-vn/index/classes/Sprite#interactivechildren)

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-20]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`isCachedAsTexture`](/pixi-vn/index/classes/Sprite#iscachedastexture)

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-21]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`isInteractive`](/pixi-vn/index/classes/Sprite#isinteractive)

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`layerParentId`](/pixi-vn/index/classes/Sprite#layerparentid)

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`localAlpha`](/pixi-vn/index/classes/Sprite#localalpha)

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`localBlendMode`](/pixi-vn/index/classes/Sprite#localblendmode)

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`localColor`](/pixi-vn/index/classes/Sprite#localcolor)

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`localDisplayStatus`](/pixi-vn/index/classes/Sprite#localdisplaystatus)

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-22]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`localTransform`](/pixi-vn/index/classes/Sprite#localtransform)

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-23]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`mask`](/pixi-vn/index/classes/Sprite#mask)

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`name`](/pixi-vn/index/classes/Sprite#name)

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onclick`](/pixi-vn/index/classes/Sprite#onclick)

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Sprite.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L99)

ListenerExtension

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onEventsHandlers`](/pixi-vn/index/classes/Sprite#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onglobalmousemove`](/pixi-vn/index/classes/Sprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onglobalpointermove`](/pixi-vn/index/classes/Sprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onglobaltouchmove`](/pixi-vn/index/classes/Sprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmousedown`](/pixi-vn/index/classes/Sprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseenter`](/pixi-vn/index/classes/Sprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseleave`](/pixi-vn/index/classes/Sprite#onmouseleave)

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmousemove`](/pixi-vn/index/classes/Sprite#onmousemove)

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseout`](/pixi-vn/index/classes/Sprite#onmouseout)

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseover`](/pixi-vn/index/classes/Sprite#onmouseover)

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseup`](/pixi-vn/index/classes/Sprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onmouseupoutside`](/pixi-vn/index/classes/Sprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointercancel`](/pixi-vn/index/classes/Sprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerdown`](/pixi-vn/index/classes/Sprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerenter`](/pixi-vn/index/classes/Sprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerleave`](/pixi-vn/index/classes/Sprite#onpointerleave)

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointermove`](/pixi-vn/index/classes/Sprite#onpointermove)

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerout`](/pixi-vn/index/classes/Sprite#onpointerout)

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerover`](/pixi-vn/index/classes/Sprite#onpointerover)

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointertap`](/pixi-vn/index/classes/Sprite#onpointertap)

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerup`](/pixi-vn/index/classes/Sprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onpointerupoutside`](/pixi-vn/index/classes/Sprite#onpointerupoutside)

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-46]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onrightclick`](/pixi-vn/index/classes/Sprite#onrightclick)

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onrightdown`](/pixi-vn/index/classes/Sprite#onrightdown)

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onrightup`](/pixi-vn/index/classes/Sprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onrightupoutside`](/pixi-vn/index/classes/Sprite#onrightupoutside)

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontap`](/pixi-vn/index/classes/Sprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontouchcancel`](/pixi-vn/index/classes/Sprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontouchend`](/pixi-vn/index/classes/Sprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontouchendoutside`](/pixi-vn/index/classes/Sprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontouchmove`](/pixi-vn/index/classes/Sprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`ontouchstart`](/pixi-vn/index/classes/Sprite#ontouchstart)

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`onwheel`](/pixi-vn/index/classes/Sprite#onwheel)

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-58]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`parent`](/pixi-vn/index/classes/Sprite#parent)

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`parentRenderLayer`](/pixi-vn/index/classes/Sprite#parentrenderlayer)

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_IMAGE_ID`

Defined in: [src/canvas/components/ImageSprite.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L50)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Overrides [#overrides-1]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`pixivnId`](/pixi-vn/index/classes/Sprite#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`relativeGroupTransform`](/pixi-vn/index/classes/Sprite#relativegrouptransform)

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:151

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`renderPipeId`](/pixi-vn/index/classes/Sprite#renderpipeid)

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-59]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-60]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`sortChildren`](/pixi-vn/index/classes/Sprite#sortchildren)

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-61]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`tabIndex`](/pixi-vn/index/classes/Sprite#tabindex)

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`uid`](/pixi-vn/index/classes/Sprite#uid)

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-62]

```ts
// Basic update after changes
container.updateCacheTexture();
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`updateCacheTexture`](/pixi-vn/index/classes/Sprite#updatecachetexture)

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`updateTick`](/pixi-vn/index/classes/Sprite#updatetick)

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-63]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`prefixed`](/pixi-vn/index/classes/Sprite#prefixed)

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L140)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L128)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`align`](/pixi-vn/index/classes/Sprite#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-64]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`alpha`](/pixi-vn/index/classes/Sprite#alpha)

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:256

The anchor sets the origin point of the sprite. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

* The default is `(0,0)`, this means the sprite's origin is the top left.
* Setting the anchor to `(0.5,0.5)` means the sprite's origin is centered.
* Setting the anchor to `(1,1)` would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-65]

```ts
// Center the anchor point
sprite.anchor = 0.5; // Sets both x and y to 0.5
sprite.position.set(400, 300); // Sprite will be centered at this position

// Set specific x/y anchor points
sprite.anchor = {
    x: 1, // Right edge
    y: 0  // Top edge
};

// Using individual coordinates
sprite.anchor.set(0.5, 1); // Center-bottom

// For rotation around center
sprite.anchor.set(0.5);
sprite.rotation = Math.PI / 4; // 45 degrees around center

// For scaling from center
sprite.anchor.set(0.5);
sprite.scale.set(2); // Scales from center point
```

##### Returns [#returns-10]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:257

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`anchor`](/pixi-vn/index/classes/Sprite#anchor)

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`angle`](/pixi-vn/index/classes/Sprite#angle)

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`blendMode`](/pixi-vn/index/classes/Sprite#blendmode)

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-68]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-16]

`Bounds`

The rectangular bounds of the view

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`bounds`](/pixi-vn/index/classes/Sprite#bounds)

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-17]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-18]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`filters`](/pixi-vn/index/classes/Sprite#filters)

***

### haveEmptyTexture [#haveemptytexture]

#### Get Signature [#get-signature-7]

\> **get** **haveEmptyTexture**(): `boolean`

Defined in: [src/canvas/components/ImageSprite.ts:138](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L138)

Check if the texture is empty.

##### Returns [#returns-19]

`boolean`

A boolean that is true if the texture is empty.

***

### height [#height]

#### Get Signature [#get-signature-8]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:300

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-71]

```ts
// Set height directly
sprite.height = 150;
console.log(sprite.scale.y); // Scale adjusted to match height

// Set height while preserving aspect ratio
const ratio = sprite.width / sprite.height;
sprite.height = 200;
sprite.width = 200 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.height = sprite.texture.orig.height;
```

##### Returns [#returns-20]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:301

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-72]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-21]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`height`](/pixi-vn/index/classes/Sprite#height)

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-9]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-22]

`boolean`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`isRenderable`](/pixi-vn/index/classes/Sprite#isrenderable)

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-10]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-23]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-24]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`isRenderGroup`](/pixi-vn/index/classes/Sprite#isrendergroup)

***

### loadIsStarted [#loadisstarted]

#### Get Signature [#get-signature-11]

\> **get** **loadIsStarted**(): `boolean`

Defined in: [src/canvas/components/ImageSprite.ts:96](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L96)

##### Returns [#returns-25]

`boolean`

***

### memory [#memory-1]

#### Get Signature [#get-signature-12]

\> **get** **memory**(): [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)

Defined in: [src/canvas/components/ImageSprite.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L64)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-26]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)

#### Overrides [#overrides-2]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`memory`](/pixi-vn/index/classes/Sprite#memory-1)

***

### origin [#origin]

#### Get Signature [#get-signature-13]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-73]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-27]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-28]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`origin`](/pixi-vn/index/classes/Sprite#origin)

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-14]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:211](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L211)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-29]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L199)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-30]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`percentagePosition`](/pixi-vn/index/classes/Sprite#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-15]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Sprite.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L217)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-31]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:220](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L220)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-32]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`percentageX`](/pixi-vn/index/classes/Sprite#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-16]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Sprite.ts:226](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L226)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-33]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:229](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L229)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-34]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`percentageY`](/pixi-vn/index/classes/Sprite#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-17]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-74]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-35]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-14]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-36]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`pivot`](/pixi-vn/index/classes/Sprite#pivot)

***

### position [#position]

#### Get Signature [#get-signature-18]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Sprite.ts:301](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L301)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-75]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-37]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L304)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-38]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`position`](/pixi-vn/index/classes/Sprite#position)

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-19]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Sprite.ts:243](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L243)

##### Returns [#returns-39]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:253](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L253)

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-40]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`positionInfo`](/pixi-vn/index/classes/Sprite#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-20]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Sprite.ts:235](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L235)

##### Returns [#returns-41]

`"pixel"` | `"percentage"` | `"align"`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`positionType`](/pixi-vn/index/classes/Sprite#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-21]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-77]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-42]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-43]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`renderable`](/pixi-vn/index/classes/Sprite#renderable)

***

### rotation [#rotation]

#### Get Signature [#get-signature-22]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-78]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-44]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-45]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`rotation`](/pixi-vn/index/classes/Sprite#rotation)

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-23]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-79]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-46]

`boolean`

#### Set Signature [#set-signature-17]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-19]

###### value [#value-15]

`boolean`

##### Returns [#returns-47]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`roundPixels`](/pixi-vn/index/classes/Sprite#roundpixels)

***

### scale [#scale]

#### Get Signature [#get-signature-24]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-80]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-48]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-20]

###### value [#value-16]

`string` | `number` | `PointData`

##### Returns [#returns-49]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`scale`](/pixi-vn/index/classes/Sprite#scale)

***

### skew [#skew]

#### Get Signature [#get-signature-25]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-81]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-50]

`ObservablePoint`

#### Set Signature [#set-signature-19]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-21]

###### value [#value-17]

`PointData`

##### Returns [#returns-51]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`skew`](/pixi-vn/index/classes/Sprite#skew)

***

### texture [#texture]

#### Get Signature [#get-signature-26]

\> **get** **texture**(): `Texture`\<`TextureSource`\<`any`>>

Defined in: [src/canvas/components/ImageSprite.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L130)

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-82]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-20]

* [Texture](/pixi-vn/index/variables/Texture) For texture creation and management
* [Assets](/pixi-vn/index/variables/Assets) For asset loading

##### Returns [#returns-52]

`Texture`\<`TextureSource`\<`any`>>

#### Set Signature [#set-signature-20]

\> **set** **texture**(`value`): `void`

Defined in: [src/canvas/components/ImageSprite.ts:126](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L126)

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-83]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-21]

* [Texture](/pixi-vn/index/variables/Texture) For texture creation and management
* [Assets](/pixi-vn/index/variables/Assets) For asset loading

##### Parameters [#parameters-22]

###### value [#value-18]

`Texture`\<`TextureSource`\<`any`>>

##### Returns [#returns-53]

`void`

#### Overrides [#overrides-3]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`texture`](/pixi-vn/index/classes/Sprite#texture)

***

### textureAlias [#texturealias-1]

#### Get Signature [#get-signature-27]

\> **get** `protected` **textureAlias**(): `string`

Defined in: [src/canvas/components/ImageSprite.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L44)

##### Returns [#returns-54]

`string`

***

### tint [#tint]

#### Get Signature [#get-signature-28]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-84]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-22]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-55]

`number`

#### Set Signature [#set-signature-21]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-23]

###### value [#value-19]

`ColorSource`

##### Returns [#returns-56]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`tint`](/pixi-vn/index/classes/Sprite#tint)

***

### visible [#visible]

#### Get Signature [#get-signature-29]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-85]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-23]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-57]

`boolean`

#### Set Signature [#set-signature-22]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-24]

###### value [#value-20]

`boolean`

##### Returns [#returns-58]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`visible`](/pixi-vn/index/classes/Sprite#visible)

***

### visualBounds [#visualbounds]

#### Get Signature [#get-signature-30]

\> **get** **visualBounds**(): `BoundsData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:205

The bounds of the sprite, taking into account the texture's trim area.

##### Example [#example-86]

````ts
const texture = new Texture({
    source: new TextureSource({ width: 300, height: 300 }),
    frame: new Rectangle(196, 66, 58, 56),
    trim: new Rectangle(4, 4, 58, 56),
    orig: new Rectangle(0, 0, 64, 64),
    rotate: 2,
});
const sprite = new Sprite(texture);
const visualBounds = sprite.visualBounds;
// console.log(visualBounds); // { minX: -4, maxX: 62, minY: -4, maxY: 60 }

##### Returns

`BoundsData`

#### Inherited from

[`Sprite`](/pixi-vn/index/classes/Sprite).[`visualBounds`](/pixi-vn/index/classes/Sprite#visualbounds)

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: node\_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:278

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example

```ts
// Set width directly
sprite.width = 200;
console.log(sprite.scale.x); // Scale adjusted to match width

// Set width while preserving aspect ratio
const ratio = sprite.height / sprite.width;
sprite.width = 300;
sprite.height = 300 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.width = sprite.texture.orig.width;
````

##### Returns [#returns-59]

`number`

#### Set Signature [#set-signature-23]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:279

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-25]

###### value [#value-21]

`number`

##### Returns [#returns-60]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`width`](/pixi-vn/index/classes/Sprite#width)

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-31]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-24]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-61]

`Matrix`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`worldTransform`](/pixi-vn/index/classes/Sprite#worldtransform)

***

### x [#x-2]

#### Get Signature [#get-signature-32]

> **get** **x**(): `number`

Defined in: [src/canvas/components/Sprite.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L309)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-62]

`number`

#### Set Signature [#set-signature-24]

> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:312](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L312)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-63]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`x`](/pixi-vn/index/classes/Sprite#x)

***

### xAlign [#xalign]

#### Get Signature [#get-signature-33]

> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:168](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L168)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-64]

`number`

#### Set Signature [#set-signature-25]

> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:162](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L162)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-65]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`xAlign`](/pixi-vn/index/classes/Sprite#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-34]

> **get** **y**(): `number`

Defined in: [src/canvas/components/Sprite.ts:317](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L317)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-66]

`number`

#### Set Signature [#set-signature-26]

> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:320](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L320)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-28]

###### value [#value-24]

`number`

##### Returns [#returns-67]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`y`](/pixi-vn/index/classes/Sprite#y)

***

### yAlign [#yalign]

#### Get Signature [#get-signature-35]

> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:186](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L186)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-68]

`number`

#### Set Signature [#set-signature-27]

> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L180)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-29]

###### value [#value-25]

`number`

##### Returns [#returns-69]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`yAlign`](/pixi-vn/index/classes/Sprite#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-30]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-70]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_getGlobalBoundsRecursive`](/pixi-vn/index/classes/Sprite#_getglobalboundsrecursive)

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-31]

##### now [#now]

`number`

#### Returns [#returns-71]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`_onTouch`](/pixi-vn/index/classes/Sprite#_ontouch)

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-32]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-72]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-25]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`addChild`](/pixi-vn/index/classes/Sprite#addchild)

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-33]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-73]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-26]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`addChildAt`](/pixi-vn/index/classes/Sprite#addchildat)

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-34]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-74]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`addEventListener`](/pixi-vn/index/classes/Sprite#addeventlistener)

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-35]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-75]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`addEventListener`](/pixi-vn/index/classes/Sprite#addeventlistener)

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-36]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-76]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`addListener`](/pixi-vn/index/classes/Sprite#addlistener)

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-37]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-77]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`collectRenderables`](/pixi-vn/index/classes/Sprite#collectrenderables)

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-38]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-78]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`collectRenderablesSimple`](/pixi-vn/index/classes/Sprite#collectrenderablessimple)

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-39]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-79]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`collectRenderablesWithEffects`](/pixi-vn/index/classes/Sprite#collectrenderableswitheffects)

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-40]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-80]

`boolean`

True if the point is within the view's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-27]

* [ViewContainer#bounds](/pixi-vn/index/classes/VideoSprite#bounds) For the bounds used in hit testing
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting global coordinates to local

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`containsPoint`](/pixi-vn/index/classes/Sprite#containspoint)

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-41]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-81]

`void`

#### Example [#example-97]

```ts
sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`destroy`](/pixi-vn/index/classes/Sprite#destroy)

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-82]

`void`

#### Advanced [#advanced-9]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`disableRenderGroup`](/pixi-vn/index/classes/Sprite#disablerendergroup)

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-42]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-83]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-98]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`dispatchEvent`](/pixi-vn/index/classes/Sprite#dispatchevent)

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-43]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-84]

`boolean`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`emit`](/pixi-vn/index/classes/Sprite#emit)

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-85]

`void`

#### Advanced [#advanced-10]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`enableRenderGroup`](/pixi-vn/index/classes/Sprite#enablerendergroup)

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-86]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`eventNames`](/pixi-vn/index/classes/Sprite#eventnames)

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-44]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-87]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-99]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-28]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getBounds`](/pixi-vn/index/classes/Sprite#getbounds)

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-45]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-88]

`U`

The child at the given index

#### Example [#example-100]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-29]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getChildAt`](/pixi-vn/index/classes/Sprite#getchildat)

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-46]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-89]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-101]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-30]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getChildByLabel`](/pixi-vn/index/classes/Sprite#getchildbylabel)

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-47]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-90]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-31]

Container#getChildByLabel

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getChildByName`](/pixi-vn/index/classes/Sprite#getchildbyname)

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-48]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-91]

`number`

The index position of the child container

#### Example [#example-102]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-32]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getChildIndex`](/pixi-vn/index/classes/Sprite#getchildindex)

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-49]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-92]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-103]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-33]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getChildrenByLabel`](/pixi-vn/index/classes/Sprite#getchildrenbylabel)

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-50]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-93]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getFastGlobalBounds`](/pixi-vn/index/classes/Sprite#getfastglobalbounds)

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-51]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-94]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getGlobalAlpha`](/pixi-vn/index/classes/Sprite#getglobalalpha)

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-52]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-95]

`Point`

The updated point

#### Example [#example-105]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-34]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getGlobalPosition`](/pixi-vn/index/classes/Sprite#getglobalposition)

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-53]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-96]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getGlobalTint`](/pixi-vn/index/classes/Sprite#getglobaltint)

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-54]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-97]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getGlobalTransform`](/pixi-vn/index/classes/Sprite#getglobaltransform)

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-98]

`Bounds`

The bounding area

#### Example [#example-108]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-35]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getLocalBounds`](/pixi-vn/index/classes/Sprite#getlocalbounds)

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:322

Retrieves the size of the Sprite as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-55]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-99]

`Size`

The size of the Sprite

#### Example [#example-109]

```ts
// Basic size retrieval
const sprite = new Sprite(Texture.from('sprite.png'));
const size = sprite.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
sprite.getSize(reuseSize);
```

#### See [#see-36]

* [Sprite#width](/pixi-vn/index/classes/Sprite#width) For getting just the width
* [Sprite#height](/pixi-vn/index/classes/Sprite#height) For getting just the height
* [Sprite#setSize](/pixi-vn/index/classes/Sprite#setsize) For setting both width and height

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`getSize`](/pixi-vn/index/classes/Sprite#getsize)

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-56]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-100]

`number`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`listenerCount`](/pixi-vn/index/classes/Sprite#listenercount)

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-57]

##### event [#event-3]

`T`

#### Returns [#returns-101]

(...`args`) => `void`\[]

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`listeners`](/pixi-vn/index/classes/Sprite#listeners)

***

### load() [#load]

> **load**(): `Promise`\<`void`>

Defined in: [src/canvas/components/ImageSprite.ts:103](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L103)

Load the image from the link and set the texture of the sprite.

#### Returns [#returns-102]

`Promise`\<`void`>

A promise that resolves when the image is loaded.

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-58]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-103]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`off`](/pixi-vn/index/classes/Sprite#off)

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Sprite.ts:100](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L100)

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-59]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-104]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`on`](/pixi-vn/index/classes/Sprite#on)

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-60]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-105]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`once`](/pixi-vn/index/classes/Sprite#once)

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Sprite.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L262)

#### Returns [#returns-106]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`reloadPosition`](/pixi-vn/index/classes/Sprite#reloadposition)

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-61]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-107]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeAllListeners`](/pixi-vn/index/classes/Sprite#removealllisteners)

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-62]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-108]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-37]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeChild`](/pixi-vn/index/classes/Sprite#removechild)

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-63]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-109]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-38]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeChildAt`](/pixi-vn/index/classes/Sprite#removechildat)

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-64]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-110]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-39]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeChildren`](/pixi-vn/index/classes/Sprite#removechildren)

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-65]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-111]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeEventListener`](/pixi-vn/index/classes/Sprite#removeeventlistener)

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-66]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-112]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeEventListener`](/pixi-vn/index/classes/Sprite#removeeventlistener)

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-113]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-40]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeFromParent`](/pixi-vn/index/classes/Sprite#removefromparent)

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-67]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-114]

`this`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`removeListener`](/pixi-vn/index/classes/Sprite#removelistener)

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-68]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-115]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-41]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`reparentChild`](/pixi-vn/index/classes/Sprite#reparentchild)

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-69]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-116]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-42]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`reparentChildAt`](/pixi-vn/index/classes/Sprite#reparentchildat)

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-70]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-117]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`replaceChild`](/pixi-vn/index/classes/Sprite#replacechild)

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-71]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-118]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-43]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`setChildIndex`](/pixi-vn/index/classes/Sprite#setchildindex)

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-72]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-119]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-44]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`setFromMatrix`](/pixi-vn/index/classes/Sprite#setfrommatrix)

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-73]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-120]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-45]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`setMask`](/pixi-vn/index/classes/Sprite#setmask)

***

### setMemory() [#setmemory]

> **setMemory**(`memory`): `Promise`\<`void`>

Defined in: [src/canvas/components/ImageSprite.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L71)

This method set the memory of the canvas element.

#### Parameters [#parameters-74]

##### memory [#memory-2]

[`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory) | `Memory`

#### Returns [#returns-121]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Overrides [#overrides-4]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`setMemory`](/pixi-vn/index/classes/Sprite#setmemory)

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:353

Sets the size of the Sprite to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-75]

##### value [#value-26]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-122]

`void`

#### Example [#example-119]

```ts
// Basic size setting
const sprite = new Sprite(Texture.from('sprite.png'));
sprite.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
sprite.setSize(100); // Sets both width and height to 100

// Set size with object
sprite.setSize({
    width: 200,
    height: 300
});

// Reset to texture size
sprite.setSize(
    sprite.texture.orig.width,
    sprite.texture.orig.height
);
```

#### See [#see-46]

* [Sprite#width](/pixi-vn/index/classes/Sprite#width) For setting width only
* [Sprite#height](/pixi-vn/index/classes/Sprite#height) For setting height only
* [Sprite#texture](/pixi-vn/index/classes/Sprite#texture) For the source dimensions

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`setSize`](/pixi-vn/index/classes/Sprite#setsize)

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-76]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-123]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-47]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`swapChildren`](/pixi-vn/index/classes/Sprite#swapchildren)

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-77]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-124]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-48]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`toGlobal`](/pixi-vn/index/classes/Sprite#toglobal)

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-78]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-125]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-49]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`toLocal`](/pixi-vn/index/classes/Sprite#tolocal)

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-126]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`unload`](/pixi-vn/index/classes/Sprite#unload)

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-127]

`void`

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`updateLocalTransform`](/pixi-vn/index/classes/Sprite#updatelocaltransform)

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-79]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-128]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-50]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`updateTransform`](/pixi-vn/index/classes/Sprite#updatetransform)

***

### from() [#from-1]

> `static` **from**(`source`, `skipCache?`): `ImageSprite`\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

Defined in: [src/canvas/components/ImageSprite.ts:89](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L89)

Creates a new sprite based on a source texture, image, video, or canvas element.
This is a convenience method that automatically creates and manages textures.

#### Parameters [#parameters-80]

##### source [#source]

`Texture`\<`TextureSource`\<`any`>> | [`TextureSourceLike`](/pixi-vn/index/type-aliases/TextureSourceLike)

The source to create the sprite from. Can be a path to an image, a texture,
or any valid texture source (canvas, video, etc.)

##### skipCache? [#skipcache]

`boolean`

Whether to skip adding to the texture cache when creating a new texture

#### Returns [#returns-129]

`ImageSprite`\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>

A new sprite based on the source

#### Example [#example-124]

```ts
// Create from path or URL
const sprite = Sprite.from('assets/image.png');

// Create from existing texture
const sprite = Sprite.from(texture);

// Create from canvas
const canvas = document.createElement('canvas');
const sprite = Sprite.from(canvas, true); // Skip caching new texture
```

#### See [#see-51]

* Texture.from For texture creation details
* [Assets](/pixi-vn/index/variables/Assets) For asset loading and management

#### Overrides [#overrides-5]

[`Sprite`](/pixi-vn/index/classes/Sprite).[`from`](/pixi-vn/index/classes/Sprite#from)

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-81]

##### source [#source-1]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-130]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

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

[`Sprite`](/pixi-vn/index/classes/Sprite).[`mixin`](/pixi-vn/index/classes/Sprite#mixin)


# Class: Label<T> (/pixi-vn/index/classes/Label)



Defined in: [src/narration/classes/Label.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L33)

Label is a class that contains a list of steps, which will be performed as the game continues.
For Ren'py this is the equivalent of a label.

## Example [#example]

```ts
const START_LABEL_ID = "StartLabel"

export const startLabel = newLabel(START_LABEL_ID,
    [
        (props) => {
            canvas.clear()
            narration.dialogue = { character: liam, text: "Which test do you want to perform?" }
            narration.choices = [
                newChoiceOption("Events Test", eventsTestLabel),
                newChoiceOption("Show Image Test", showImageTest),
            ]
        },
        (props) => narration.jump(START_LABEL_ID, props),
    ]
)

narration.call(StartLabel)
```

## Extends [#extends]

* [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`Label`\<`T`>, `T`>

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Label**\<`T`>(`id`, `steps`, `props?`): `Label`\<`T`>

Defined in: [src/narration/classes/Label.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L45)

#### Parameters [#parameters]

##### id [#id]

`string`

is the id of the label

##### steps [#steps]

[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`>\[] | (() => [`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`>\[])

is the list of steps that the label will perform

##### props? [#props]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps)\<`Label`\<`T`>, `number`>

is the properties of the label

#### Returns [#returns]

`Label`\<`T`>

#### Overrides [#overrides]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`constructor`](/pixi-vn/index/classes/LabelAbstract#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/narration/classes/LabelAbstract.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L22)

Get the id of the label. This variable is used in the system to get the label by id, [RegisteredLabels.get](/pixi-vn/index/namespaces/RegisteredLabels/functions/get)

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

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`id`](/pixi-vn/index/classes/LabelAbstract#id)

## Accessors [#accessors]

### onLoadingLabel [#onloadinglabel]

#### Get Signature [#get-signature]

\> **get** **onLoadingLabel**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:60](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L60)

Is a function that will be executed in [onStepStart](/pixi-vn/index/interfaces/LabelProps#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narration.openedLabels](/pixi-vn/index/interfaces/NarrationManagerInterface#openedlabels).
It is useful for example to make sure all images used have been cached

##### Example [#example-1]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

##### Returns [#returns-1]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Is a function that will be executed in [onStepStart](/pixi-vn/index/interfaces/LabelProps#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narration.openedLabels](/pixi-vn/index/interfaces/NarrationManagerInterface#openedlabels).
It is useful for example to make sure all images used have been cached

#### Example [#example-2]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

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

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`onLoadingLabel`](/pixi-vn/index/classes/LabelAbstract#onloadinglabel)

***

### onStepEnd [#onstepend]

#### Get Signature [#get-signature-1]

\> **get** **onStepEnd**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:67](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L67)

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

##### Example [#example-3]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

##### Returns [#returns-2]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

#### Example [#example-4]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

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

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`onStepEnd`](/pixi-vn/index/classes/LabelAbstract#onstepend)

***

### onStepStart [#onstepstart]

#### Get Signature [#get-signature-2]

\> **get** **onStepStart**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L44)

A function executed before each `step`.

##### Example [#example-5]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```

##### Returns [#returns-3]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

A function executed before each `step`.

#### Example [#example-6]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```

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

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`onStepStart`](/pixi-vn/index/classes/LabelAbstract#onstepstart)

***

### stepCount [#stepcount]

#### Get Signature [#get-signature-3]

\> **get** **stepCount**(): `number`

Defined in: [src/narration/classes/Label.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L34)

Get the number of steps in the label. This variable is used in the system to get the number of steps in the label.

##### Returns [#returns-4]

`number`

The number of steps in the label

#### Overrides [#overrides-1]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`stepCount`](/pixi-vn/index/classes/LabelAbstract#stepcount)

***

### steps [#steps-1]

#### Get Signature [#get-signature-4]

\> **get** **steps**(): [`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`>\[]

Defined in: [src/narration/classes/Label.ts:58](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L58)

Get the steps of the label.

##### Returns [#returns-5]

[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`>\[]

## Methods [#methods]

### getStepById() [#getstepbyid]

\> **getStepById**(`stepId`): [`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`> | `undefined`

Defined in: [src/narration/classes/Label.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L37)

Get the step by id

#### Parameters [#parameters-1]

##### stepId [#stepid]

`number`

Id of the step

#### Returns [#returns-6]

[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`> | `undefined`

The step or undefined if it does not exist

#### Overrides [#overrides-2]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`getStepById`](/pixi-vn/index/classes/LabelAbstract#getstepbyid)

***

### getStepSha() [#getstepsha]

\> **getStepSha**(`index`): `string`

Defined in: [src/narration/classes/Label.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/Label.ts#L65)

Get the sha of the step

#### Parameters [#parameters-2]

##### index [#index]

`number`

Index of the step

#### Returns [#returns-7]

`string`

#### Overrides [#overrides-3]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract).[`getStepSha`](/pixi-vn/index/classes/LabelAbstract#getstepsha)


# Abstract Class: LabelAbstract<TLabel, TProps, StepIdType> (/pixi-vn/index/classes/LabelAbstract)



Defined in: [src/narration/classes/LabelAbstract.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L5)

## Extended by [#extended-by]

* [`Label`](/pixi-vn/index/classes/Label)

## Type Parameters [#type-parameters]

### TLabel [#tlabel]

`TLabel`

### TProps [#tprops]

`TProps` *extends* `object` = \{ }

### StepIdType [#stepidtype]

`StepIdType` = `number`

## Implements [#implements]

* [`LabelProps`](/pixi-vn/index/interfaces/LabelProps)\<`TLabel`, `StepIdType`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new LabelAbstract**\<`TLabel`, `TProps`, `StepIdType`>(`id`, `props?`): `LabelAbstract`\<`TLabel`, `TProps`, `StepIdType`>

Defined in: [src/narration/classes/LabelAbstract.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L12)

#### Parameters [#parameters]

##### id [#id]

`string`

is the id of the label

##### props? [#props]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps)\<`TLabel`, `StepIdType`>

is the properties of the label

#### Returns [#returns]

`LabelAbstract`\<`TLabel`, `TProps`, `StepIdType`>

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/narration/classes/LabelAbstract.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L22)

Get the id of the label. This variable is used in the system to get the label by id, [RegisteredLabels.get](/pixi-vn/index/namespaces/RegisteredLabels/functions/get)

## Accessors [#accessors]

### onLoadingLabel [#onloadinglabel]

#### Get Signature [#get-signature]

\> **get** **onLoadingLabel**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:60](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L60)

Is a function that will be executed in [onStepStart](/pixi-vn/index/interfaces/LabelProps#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narration.openedLabels](/pixi-vn/index/interfaces/NarrationManagerInterface#openedlabels).
It is useful for example to make sure all images used have been cached

##### Example [#example]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

##### Returns [#returns-1]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Is a function that will be executed in [onStepStart](/pixi-vn/index/interfaces/LabelProps#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narration.openedLabels](/pixi-vn/index/interfaces/NarrationManagerInterface#openedlabels).
It is useful for example to make sure all images used have been cached

#### Example [#example-1]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

#### Implementation of [#implementation-of]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps).[`onLoadingLabel`](/pixi-vn/index/interfaces/LabelProps#onloadinglabel)

***

### onStepEnd [#onstepend]

#### Get Signature [#get-signature-1]

\> **get** **onStepEnd**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:67](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L67)

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

##### Example [#example-2]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

##### Returns [#returns-2]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

#### Example [#example-3]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

#### Implementation of [#implementation-of-1]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps).[`onStepEnd`](/pixi-vn/index/interfaces/LabelProps#onstepend)

***

### onStepStart [#onstepstart]

#### Get Signature [#get-signature-2]

\> **get** **onStepStart**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L44)

A function executed before each `step`.

##### Example [#example-4]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```

##### Returns [#returns-3]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

A function executed before each `step`.

#### Example [#example-5]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```

#### Implementation of [#implementation-of-2]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps).[`onStepStart`](/pixi-vn/index/interfaces/LabelProps#onstepstart)

***

### stepCount [#stepcount]

#### Get Signature [#get-signature-3]

\> **get** `abstract` **stepCount**(): `number`

Defined in: [src/narration/classes/LabelAbstract.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L28)

Get the number of steps in the label. This variable is used in the system to get the number of steps in the label.

##### Returns [#returns-4]

`number`

The number of steps in the label

## Methods [#methods]

### getStepById() [#getstepbyid]

\> `abstract` **getStepById**(`stepId`): [`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`TProps`> | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L41)

Get the step by id

#### Parameters [#parameters-1]

##### stepId [#stepid]

`StepIdType`

Id of the step

#### Returns [#returns-5]

[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`TProps`> | `undefined`

The step or undefined if it does not exist

***

### getStepSha() [#getstepsha]

\> `abstract` **getStepSha**(`stepId`): `string` | `undefined`

Defined in: [src/narration/classes/LabelAbstract.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/LabelAbstract.ts#L34)

Get the sha of the step

#### Parameters [#parameters-2]

##### stepId [#stepid-1]

`StepIdType`

#### Returns [#returns-6]

`string` | `undefined`


# Class: NarrationManagerStatic (/pixi-vn/index/classes/NarrationManagerStatic)



Defined in: [src/narration/NarrationManagerStatic.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L27)

## Properties [#properties]

### \_stepCounter [#_stepcounter]

\> `static` **\_stepCounter**: `number` = `0`

Defined in: [src/narration/NarrationManagerStatic.ts:202](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L202)

***

### choiceMadeTemp [#choicemadetemp]

\> `static` **choiceMadeTemp**: `number` | `undefined` = `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L29)

***

### lastHistoryStep [#lasthistorystep]

\> `static` **lastHistoryStep**: `Omit`\<[`HistoryStep`](/pixi-vn/index/interfaces/HistoryStep), `"diff"`> | `null` = `null`

Defined in: [src/narration/NarrationManagerStatic.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L30)

***

### onLabelClosing? [#onlabelclosing]

\> `static` `optional` **onLabelClosing?**: (`labelId`, `props`, `defaultClose`) => [`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/NarrationManagerStatic.ts:396](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L396)

Is a function that will be executed every time the current label is about to close because it
naturally ran out of steps - either control is returning to the label that called it, or, if
there's no parent label left on the stack, the game is about to end (see [Game.onEnd](/pixi-vn/index/namespaces/Game/functions/onEnd)).

By default (when this is not set), the label is closed immediately, exactly like before this
hook existed. If you set it, you take control: call `defaultClose()` yourself whenever you want
the label to actually close (right away, or later, e.g. from a subsequent `next()`-like action in
your template). Until `defaultClose()` is called, the label stays open: it is not popped off the
opened labels stack, narration does not continue into the parent label, and the game does not end
even if this was the last label - this is what lets an app show the final paragraph of a story
before actually ending it, instead of both happening within the same `continue()` call.

This does not fire for a `jump` or a choice's `closeCurrentLabel` option - those close the
current label explicitly as part of starting a new one, so [onLabelStarting](#onlabelstarting) already
covers deferring them.

#### Parameters [#parameters]

##### labelId [#labelid]

`string`

##### props [#props]

`StepLabelProps`

##### defaultClose [#defaultclose]

() => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

#### Returns [#returns]

[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### onLabelStarting? [#onlabelstarting]

\> `static` `optional` **onLabelStarting?**: (`labelId`, `props`, `options`, `defaultStart`) => [`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/NarrationManagerStatic.ts:369](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L369)

Is a function that will be executed every time a label is about to be started, either via
`call` or `jump` (this includes labels started through a choice of type `"call"` or `"jump"`).

By default (when this is not set), the label is started immediately, exactly like before this
hook existed. If you set it, you take control: call `defaultStart()` yourself whenever you want
the label to actually run (right away, or later, e.g. from a subsequent `next()`-like action in
your template). Until `defaultStart()` is called, nothing about the label happens: it is not
added to the history and no step of it runs.

#### Parameters [#parameters-1]

##### labelId [#labelid-1]

`string`

##### props [#props-1]

`StepLabelProps`

##### options [#options]

###### choiceMade? [#choicemade]

`number`

###### closeCurrentLabel? [#closecurrentlabel]

`boolean`

###### type [#type]

`string`

##### defaultStart [#defaultstart]

() => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

#### Returns [#returns-1]

[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### onLoadingLabel? [#onloadinglabel]

\> `static` `optional` **onLoadingLabel?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/NarrationManagerStatic.ts:357](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L357)

#### Parameters [#parameters-2]

##### stepId [#stepid]

`number`

##### label [#label]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`>

#### Returns [#returns-2]

`void` | `Promise`\<`void`>

***

### onStepEnd? [#onstepend]

\> `static` `optional` **onStepEnd?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/NarrationManagerStatic.ts:358](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L358)

#### Parameters [#parameters-3]

##### stepId [#stepid-1]

`number`

##### label [#label-1]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`>

#### Returns [#returns-3]

`void` | `Promise`\<`void`>

## Accessors [#accessors]

### \_currentLabel [#_currentlabel]

#### Get Signature [#get-signature]

\> **get** `static` **\_currentLabel**(): [`Label`](/pixi-vn/index/classes/Label)\<\{ }> | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:223](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L223)

##### Returns [#returns-4]

[`Label`](/pixi-vn/index/classes/Label)\<\{ }> | `undefined`

***

### allChoicesMade [#allchoicesmade]

#### Get Signature [#get-signature-1]

\> **get** `static` **allChoicesMade**(): `ChoicesMadeType`\[]

Defined in: [src/narration/NarrationManagerStatic.ts:187](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L187)

is a list of all choices made by the player during the progression of the steps.

##### Returns [#returns-5]

`ChoicesMadeType`\[]

#### Set Signature [#set-signature]

\> **set** `static` **allChoicesMade**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:195](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L195)

##### Parameters [#parameters-4]

###### value [#value]

`ChoicesMadeType`\[]

##### Returns [#returns-6]

`void`

***

### allOpenedLabels [#allopenedlabels]

#### Get Signature [#get-signature-2]

\> **get** `static` **allOpenedLabels**(): `AllOpenedLabelsType`

Defined in: [src/narration/NarrationManagerStatic.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L35)

is a list of all labels that have been opened during the progression of the steps.
the key is the label id and the biggest step opened.

##### Returns [#returns-7]

`AllOpenedLabelsType`

#### Set Signature [#set-signature-1]

\> **set** `static` **allOpenedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L43)

##### Parameters [#parameters-5]

###### value [#value-1]

`AllOpenedLabelsType`

##### Returns [#returns-8]

`void`

***

### currentLabelId [#currentlabelid]

#### Get Signature [#get-signature-3]

\> **get** `static` **currentLabelId**(): `string` | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:232](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L232)

currentLabelId is the current label id that occurred during the progression of the steps.

##### Returns [#returns-9]

`string` | `undefined`

***

### currentLabelStepIndex [#currentlabelstepindex]

#### Get Signature [#get-signature-4]

\> **get** `static` **currentLabelStepIndex**(): `number` | `null`

Defined in: [src/narration/NarrationManagerStatic.ts:242](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L242)

##### Returns [#returns-10]

`number` | `null`

***

### onStepStart [#onstepstart]

#### Get Signature [#get-signature-5]

\> **get** `static` **onStepStart**(): ((`stepId`, `label`) => `Promise`\<`void`\[]>) | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:343](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L343)

##### Returns [#returns-11]

((`stepId`, `label`) => `Promise`\<`void`\[]>) | `undefined`

#### Set Signature [#set-signature-2]

\> **set** `static` **onStepStart**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:337](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L337)

##### Parameters [#parameters-6]

###### value [#value-2]

(`stepId`, `label`) => `void` | `Promise`\<`void`>

##### Returns [#returns-12]

`void`

***

### openedLabels [#openedlabels]

#### Get Signature [#get-signature-6]

\> **get** `static` **openedLabels**(): [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/NarrationManagerStatic.ts:210](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L210)

##### Returns [#returns-13]

[`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

#### Set Signature [#set-signature-3]

\> **set** `static` **openedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:213](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L213)

##### Parameters [#parameters-7]

###### value [#value-3]

[`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

##### Returns [#returns-14]

`void`

***

### originalOpenedLabels [#originalopenedlabels]

#### Get Signature [#get-signature-7]

\> **get** `static` **originalOpenedLabels**(): [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/NarrationManagerStatic.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L217)

##### Returns [#returns-15]

[`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

#### Set Signature [#set-signature-4]

\> **set** `static` **originalOpenedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:220](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L220)

##### Parameters [#parameters-8]

###### value [#value-4]

[`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

##### Returns [#returns-16]

`void`

## Methods [#methods]

### addChoicesMade() [#addchoicesmade]

\> `static` **addChoicesMade**(`label`, `stepIndex`, `stepSha`, `choiceMade`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:269](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L269)

#### Parameters [#parameters-9]

##### label [#label-2]

`string`

##### stepIndex [#stepindex]

`number`

##### stepSha [#stepsha]

`string`

##### choiceMade [#choicemade-1]

`number`

#### Returns [#returns-17]

`void`

***

### addLabelHistory() [#addlabelhistory]

\> `static` **addLabelHistory**(`label`, `stepIndex`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:260](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L260)

Add a label to the history.

#### Parameters [#parameters-10]

##### label [#label-3]

`string`

The label to add to the history.

##### stepIndex [#stepindex-1]

`number`

The step index of the label.

#### Returns [#returns-18]

`void`

***

### getCurrentStepTimesCounter() [#getcurrentsteptimescounter]

\> `static` **getCurrentStepTimesCounter**(`nestedId?`): `number`

Defined in: [src/narration/NarrationManagerStatic.ts:110](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L110)

#### Parameters [#parameters-11]

##### nestedId? [#nestedid]

`string` = `""`

#### Returns [#returns-19]

`number`

***

### getCurrentStepTimesCounterData() [#getcurrentsteptimescounterdata]

\> `static` **getCurrentStepTimesCounterData**(`nestedId?`): `CurrentStepTimesCounterMemotyData` | `null`

Defined in: [src/narration/NarrationManagerStatic.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L50)

#### Parameters [#parameters-12]

##### nestedId? [#nestedid-1]

`string` = `""`

#### Returns [#returns-20]

`CurrentStepTimesCounterMemotyData` | `null`

***

### getRandomNumber() [#getrandomnumber]

\> `static` **getRandomNumber**(`min`, `max`, `options?`): `number` | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:126](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L126)

#### Parameters [#parameters-13]

##### min [#min]

`number`

##### max [#max]

`number`

##### options? [#options-1]

###### nestedId? [#nestedid-2]

`string`

###### onceOnly? [#onceonly]

`boolean`

#### Returns [#returns-21]

`number` | `undefined`

***

### increaseCurrentStepIndex() [#increasecurrentstepindex]

\> `static` **increaseCurrentStepIndex**(): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:319](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L319)

Increase the current step index of the current label.

#### Returns [#returns-22]

`void`

***

### increaseStepCounter() [#increasestepcounter]

\> `static` **increaseStepCounter**(): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:206](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L206)

Increase the last step index that occurred during the progression of the steps.

#### Returns [#returns-23]

`void`

***

### pushNewLabel() [#pushnewlabel]

\> `static` **pushNewLabel**(`label`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:301](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L301)

Add a label to the history.

#### Parameters [#parameters-14]

##### label [#label-4]

`string`

The label to add to the history.

#### Returns [#returns-24]

`void`

#### Throws [#throws]

when the label is not found in the registered labels.

***

### resetCurrentStepTimesCounter() [#resetcurrentsteptimescounter]

\> `static` **resetCurrentStepTimesCounter**(`nestedId?`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:161](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/NarrationManagerStatic.ts#L161)

#### Parameters [#parameters-15]

##### nestedId? [#nestedid-3]

`string` = `""`

#### Returns [#returns-25]

`void`


# Class: PixiError (/pixi-vn/index/classes/PixiError)



Defined in: [src/core/PixiError.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L5)

## Extends [#extends]

* `Error`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new PixiError**(`code`, `message`): `PixiError`

Defined in: [src/core/PixiError.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L7)

#### Parameters [#parameters]

##### code [#code]

[`ErrorCodeType`](/pixi-vn/index/type-aliases/ErrorCodeType)

##### message [#message]

`string`

#### Returns [#returns]

`PixiError`

#### Overrides [#overrides]

`Error.constructor`

### Constructor [#constructor-1]

\> **new PixiError**(`code`, `message`, `type`, `data`, `parent?`): `PixiError`

Defined in: [src/core/PixiError.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L8)

#### Parameters [#parameters-1]

##### code [#code-1]

[`ErrorCodeType`](/pixi-vn/index/type-aliases/ErrorCodeType)

##### message [#message-1]

`string`

##### type [#type]

`"canvas"`

##### data [#data]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory) | [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory) & `ContainerOptions`\<`ContainerChild`>

##### parent? [#parent]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`any`>

#### Returns [#returns-1]

`PixiError`

#### Overrides [#overrides-1]

`Error.constructor`

## Properties [#properties]

### canvasElementInfo? [#canvaselementinfo]

\> `optional` **canvasElementInfo?**: [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

Defined in: [src/core/PixiError.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L32)

***

### cause? [#cause]

\> `optional` **cause?**: `unknown`

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

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

`Error.cause`

***

### code [#code-2]

\> **code**: [`ErrorCodeType`](/pixi-vn/index/type-aliases/ErrorCodeType)

Defined in: [src/core/PixiError.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L6)

***

### message [#message-2]

\> **message**: `string`

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

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

`Error.message`

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

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

`Error.name`

***

### parent? [#parent-1]

\> `optional` **parent?**: [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`any`>

Defined in: [src/core/PixiError.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/PixiError.ts#L33)

***

### stack? [#stack]

\> `optional` **stack?**: `string`

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

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

`Error.stack`

***

### stackTraceLimit [#stacktracelimit]

\> `static` **stackTraceLimit**: `number`

Defined in: node_modules/@types/node/globals.d.ts:67

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

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

`Error.stackTraceLimit`

## Methods [#methods]

### captureStackTrace() [#capturestacktrace]

\> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-2]

##### targetObject [#targetobject]

`object`

##### constructorOpt? [#constructoropt]

`Function`

#### Returns [#returns-2]

`void`

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

`Error.captureStackTrace`

***

### isError() [#iserror]

\> `static` **isError**(`error`): `error is Error`

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

#### Parameters [#parameters-3]

##### error [#error]

`unknown`

#### Returns [#returns-3]

`error is Error`

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

`Error.isError`

***

### prepareStackTrace() [#preparestacktrace]

\> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

Defined in: node_modules/@types/node/globals.d.ts:55

#### Parameters [#parameters-4]

##### err [#err]

`Error`

##### stackTraces [#stacktraces]

`CallSite`\[]

#### Returns [#returns-4]

`any`

#### See [#see]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

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

`Error.prepareStackTrace`


# Class: Sprite<Memory> (/pixi-vn/index/classes/Sprite)



Defined in: [src/canvas/components/Sprite.ts:52](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L52)

This class is a extension of the [PIXI.Sprite class](https://pixijs.com/8.x/examples/sprite/basic), it has the same properties and methods,
but it has the ability to be saved and loaded by the Pixi’VN library.

## Example [#example]

```ts
const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
const sprite = Sprite.from(texture);

sprite.anchor.set(0.5);
sprite.x = canvas.screen.width / 2;
sprite.y = canvas.screen.height / 2;

sprite.eventMode = 'static';
sprite.cursor = 'pointer';
sprite.onEvent('pointerdown', EventTest);

canvas.add("bunny", sprite);
```

## Extends [#extends]

* `Sprite`

## Extended by [#extended-by]

* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)

## Type Parameters [#type-parameters]

### Memory [#memory]

`Memory` *extends* `PixiSpriteOptions` & [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory) = [`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory)

## Implements [#implements]

* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`Memory` | [`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory)>
* [`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension)
* [`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Sprite**\<`Memory`>(`options?`): `Sprite`\<`Memory`>

Defined in: [src/canvas/components/Sprite.ts:62](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L62)

#### Parameters [#parameters]

##### options? [#options]

`Texture`\<`TextureSource`\<`any`>> | [`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions)

The options for the component.

#### Returns [#returns]

`Sprite`\<`Memory`>

#### Overrides [#overrides]

`PIXI.Sprite.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

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

`PIXI.Sprite.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

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

`PIXI.Sprite.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

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

`PIXI.Sprite.__devtoolLocked`

***

### \_anchor [#_anchor]

\> `readonly` **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:155

**`Internal`**

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

`PIXI.Sprite._anchor`

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_bounds`](/pixi-vn/index/classes/VideoSprite#_bounds)

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_boundsDirty`](/pixi-vn/index/classes/VideoSprite#_boundsdirty)

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

`PIXI.Sprite._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

`PIXI.Sprite._cy`

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_gcData`](/pixi-vn/index/classes/VideoSprite#_gcdata)

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_gcLastUsed`](/pixi-vn/index/classes/VideoSprite#_gclastused)

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

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

`PIXI.Sprite._gpuData`

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_lastUsed`](/pixi-vn/index/classes/VideoSprite#_lastused)

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

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

`PIXI.Sprite._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

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

`PIXI.Sprite._position`

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`_roundPixels`](/pixi-vn/index/classes/VideoSprite#_roundpixels)

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

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

`PIXI.Sprite._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

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

`PIXI.Sprite._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

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

`PIXI.Sprite._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

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

`PIXI.Sprite._sy`

***

### \_texture [#_texture]

\> **\_texture**: `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:157

**`Internal`**

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

`PIXI.Sprite._texture`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

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

`PIXI.Sprite._zIndex`

***

### accessible? [#accessible]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

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

`PIXI.Sprite.accessible`

***

### accessibleChildren? [#accessiblechildren]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

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

`PIXI.Sprite.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

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

`PIXI.Sprite.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

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

`PIXI.Sprite.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

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

`PIXI.Sprite.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

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

`PIXI.Sprite.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

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

`PIXI.Sprite.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

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

`PIXI.Sprite.allowChildren`

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`autoGarbageCollect`](/pixi-vn/index/classes/VideoSprite#autogarbagecollect)

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:153

**`Internal`**

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

`PIXI.Sprite.batched`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

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

`PIXI.Sprite.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

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

`PIXI.Sprite.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

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

`PIXI.Sprite.cacheAsTexture`

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`canBundle`](/pixi-vn/index/classes/VideoSprite#canbundle)

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

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

`PIXI.Sprite.children`

***

### cullable? [#cullable]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

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

`PIXI.Sprite.cullable`

***

### cullableChildren? [#cullablechildren]

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

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

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

`PIXI.Sprite.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

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

`PIXI.Sprite.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

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

`PIXI.Sprite.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

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

`PIXI.Sprite.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

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

`PIXI.Sprite.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

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

`PIXI.Sprite.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

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

`PIXI.Sprite.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

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

`PIXI.Sprite.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

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

`PIXI.Sprite.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

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

`PIXI.Sprite.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

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

`PIXI.Sprite.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

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

`PIXI.Sprite.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

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

`PIXI.Sprite.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

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

`PIXI.Sprite.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

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

`PIXI.Sprite.hitArea`

***

### interactive? [#interactive]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

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

`PIXI.Sprite.interactive`

***

### interactiveChildren? [#interactivechildren]

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

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

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

`PIXI.Sprite.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

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

`PIXI.Sprite.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

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

`PIXI.Sprite.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

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

`PIXI.Sprite.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

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

`PIXI.Sprite.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

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

`PIXI.Sprite.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

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

`PIXI.Sprite.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

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

`PIXI.Sprite.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

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

`PIXI.Sprite.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

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

`PIXI.Sprite.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

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

`PIXI.Sprite.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

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

`PIXI.Sprite.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Sprite.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L99)

ListenerExtension

#### Implementation of [#implementation-of]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`onEventsHandlers`](/pixi-vn/index/interfaces/ListenerExtension#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

`PIXI.Sprite.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

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

`PIXI.Sprite.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

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

`PIXI.Sprite.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

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

`PIXI.Sprite.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

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

`PIXI.Sprite.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

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

`PIXI.Sprite.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

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

`PIXI.Sprite.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

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

`PIXI.Sprite.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

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

`PIXI.Sprite.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

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

`PIXI.Sprite.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

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

`PIXI.Sprite.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

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

`PIXI.Sprite.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

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

`PIXI.Sprite.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

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

`PIXI.Sprite.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

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

`PIXI.Sprite.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

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

`PIXI.Sprite.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

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

`PIXI.Sprite.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

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

`PIXI.Sprite.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

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

`PIXI.Sprite.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

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

`PIXI.Sprite.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

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

`PIXI.Sprite.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

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

`PIXI.Sprite.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

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

`PIXI.Sprite.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

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

`PIXI.Sprite.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

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

`PIXI.Sprite.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

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

`PIXI.Sprite.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

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

`PIXI.Sprite.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

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

`PIXI.Sprite.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

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

`PIXI.Sprite.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

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

`PIXI.Sprite.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

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

`PIXI.Sprite.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

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

`PIXI.Sprite.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

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

`PIXI.Sprite.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

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

`PIXI.Sprite.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_SPRITE_ID`

Defined in: [src/canvas/components/Sprite.ts:78](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L78)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Implementation of [#implementation-of-1]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`pixivnId`](/pixi-vn/index/classes/CanvasBaseItem#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

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

`PIXI.Sprite.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:151

**`Internal`**

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

`PIXI.Sprite.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

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

`PIXI.Sprite.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

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

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

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

`PIXI.Sprite.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

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

`PIXI.Sprite.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

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

`PIXI.Sprite.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

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

`PIXI.Sprite.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

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

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

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

`PIXI.Sprite.prefixed`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L140)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L128)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-2]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

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

`PIXI.Sprite.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:256

The anchor sets the origin point of the sprite. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

* The default is `(0,0)`, this means the sprite's origin is the top left.
* Setting the anchor to `(0.5,0.5)` means the sprite's origin is centered.
* Setting the anchor to `(1,1)` would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-66]

```ts
// Center the anchor point
sprite.anchor = 0.5; // Sets both x and y to 0.5
sprite.position.set(400, 300); // Sprite will be centered at this position

// Set specific x/y anchor points
sprite.anchor = {
    x: 1, // Right edge
    y: 0  // Top edge
};

// Using individual coordinates
sprite.anchor.set(0.5, 1); // Center-bottom

// For rotation around center
sprite.anchor.set(0.5);
sprite.rotation = Math.PI / 4; // 45 degrees around center

// For scaling from center
sprite.anchor.set(0.5);
sprite.scale.set(2); // Scales from center point
```

##### Returns [#returns-10]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:257

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

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

`PIXI.Sprite.anchor`

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-67]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

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

`PIXI.Sprite.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-68]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

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

`PIXI.Sprite.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-69]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-16]

`Bounds`

The rectangular bounds of the view

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

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`bounds`](/pixi-vn/index/classes/VideoSprite#bounds)

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-17]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-71]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-18]

`void`

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

`PIXI.Sprite.filters`

***

### height [#height]

#### Get Signature [#get-signature-7]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:300

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-72]

```ts
// Set height directly
sprite.height = 150;
console.log(sprite.scale.y); // Scale adjusted to match height

// Set height while preserving aspect ratio
const ratio = sprite.width / sprite.height;
sprite.height = 200;
sprite.width = 200 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.height = sprite.texture.orig.height;
```

##### Returns [#returns-19]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:301

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-73]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-20]

`void`

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

`PIXI.Sprite.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-8]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-21]

`boolean`

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

`PIXI.Sprite.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-9]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-22]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-23]

`void`

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

`PIXI.Sprite.isRenderGroup`

***

### memory [#memory-1]

#### Get Signature [#get-signature-10]

\> **get** **memory**(): [`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory) | `Memory`

Defined in: [src/canvas/components/Sprite.ts:79](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L79)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-24]

[`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory) | `Memory`

#### Implementation of [#implementation-of-3]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`memory`](/pixi-vn/index/classes/CanvasBaseItem#memory)

***

### origin [#origin]

#### Get Signature [#get-signature-11]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-74]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-25]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-26]

`void`

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

`PIXI.Sprite.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-12]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:211](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L211)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-27]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L199)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-28]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-4]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-13]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Sprite.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L217)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-29]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:220](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L220)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-30]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-5]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-14]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Sprite.ts:226](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L226)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-31]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:229](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L229)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-32]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-6]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-15]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-75]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-33]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-14]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-34]

`void`

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

`PIXI.Sprite.pivot`

***

### position [#position]

#### Get Signature [#get-signature-16]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Sprite.ts:301](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L301)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-35]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L304)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-77]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-36]

`void`

#### Overrides [#overrides-1]

`PIXI.Sprite.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-17]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Sprite.ts:243](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L243)

##### Returns [#returns-37]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:253](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L253)

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-38]

`void`

#### Implementation of [#implementation-of-7]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionInfo`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-18]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Sprite.ts:235](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L235)

##### Returns [#returns-39]

`"pixel"` | `"percentage"` | `"align"`

#### Implementation of [#implementation-of-8]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionType`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-19]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-78]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-40]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-41]

`void`

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

`PIXI.Sprite.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-20]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-79]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-42]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-43]

`void`

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

`PIXI.Sprite.rotation`

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-21]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-80]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-44]

`boolean`

#### Set Signature [#set-signature-17]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-19]

###### value [#value-15]

`boolean`

##### Returns [#returns-45]

`void`

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

`PIXI.Sprite.roundPixels`

***

### scale [#scale]

#### Get Signature [#get-signature-22]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-81]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-46]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-20]

###### value [#value-16]

`string` | `number` | `PointData`

##### Returns [#returns-47]

`void`

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

`PIXI.Sprite.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-23]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-82]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-48]

`ObservablePoint`

#### Set Signature [#set-signature-19]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-21]

###### value [#value-17]

`PointData`

##### Returns [#returns-49]

`void`

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

`PIXI.Sprite.skew`

***

### texture [#texture]

#### Get Signature [#get-signature-24]

\> **get** **texture**(): `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:189

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-83]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-20]

* [Texture](/pixi-vn/index/variables/Texture) For texture creation and management
* [Assets](/pixi-vn/index/variables/Assets) For asset loading

##### Returns [#returns-50]

`Texture`

#### Set Signature [#set-signature-20]

\> **set** **texture**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:165

##### Parameters [#parameters-22]

###### value [#value-18]

`Texture`

##### Returns [#returns-51]

`void`

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

`PIXI.Sprite.texture`

***

### tint [#tint]

#### Get Signature [#get-signature-25]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-84]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-21]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-52]

`number`

#### Set Signature [#set-signature-21]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-23]

###### value [#value-19]

`ColorSource`

##### Returns [#returns-53]

`void`

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

`PIXI.Sprite.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-26]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-85]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-22]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-54]

`boolean`

#### Set Signature [#set-signature-22]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-24]

###### value [#value-20]

`boolean`

##### Returns [#returns-55]

`void`

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

`PIXI.Sprite.visible`

***

### visualBounds [#visualbounds]

#### Get Signature [#get-signature-27]

\> **get** **visualBounds**(): `BoundsData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:205

The bounds of the sprite, taking into account the texture's trim area.

##### Example [#example-86]

````ts
const texture = new Texture({
    source: new TextureSource({ width: 300, height: 300 }),
    frame: new Rectangle(196, 66, 58, 56),
    trim: new Rectangle(4, 4, 58, 56),
    orig: new Rectangle(0, 0, 64, 64),
    rotate: 2,
});
const sprite = new Sprite(texture);
const visualBounds = sprite.visualBounds;
// console.log(visualBounds); // { minX: -4, maxX: 62, minY: -4, maxY: 60 }

##### Returns

`BoundsData`

#### Inherited from

`PIXI.Sprite.visualBounds`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: node\_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:278

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example

```ts
// Set width directly
sprite.width = 200;
console.log(sprite.scale.x); // Scale adjusted to match width

// Set width while preserving aspect ratio
const ratio = sprite.height / sprite.width;
sprite.width = 300;
sprite.height = 300 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.width = sprite.texture.orig.width;
````

##### Returns [#returns-56]

`number`

#### Set Signature [#set-signature-23]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:279

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-25]

###### value [#value-21]

`number`

##### Returns [#returns-57]

`void`

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

`PIXI.Sprite.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-28]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-23]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-58]

`Matrix`

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

`PIXI.Sprite.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-29]

> **get** **x**(): `number`

Defined in: [src/canvas/components/Sprite.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L309)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-59]

`number`

#### Set Signature [#set-signature-24]

> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:312](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L312)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-60]

`void`

#### Overrides [#overrides-2]

`PIXI.Sprite.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-30]

> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:168](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L168)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-61]

`number`

#### Set Signature [#set-signature-25]

> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:162](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L162)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-62]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-9]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-31]

> **get** **y**(): `number`

Defined in: [src/canvas/components/Sprite.ts:317](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L317)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-63]

`number`

#### Set Signature [#set-signature-26]

> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:320](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L320)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-28]

###### value [#value-24]

`number`

##### Returns [#returns-64]

`void`

#### Overrides [#overrides-3]

`PIXI.Sprite.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-32]

> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:186](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L186)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-65]

`number`

#### Set Signature [#set-signature-27]

> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L180)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-29]

###### value [#value-25]

`number`

##### Returns [#returns-66]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-10]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-30]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-67]

`void`

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

`PIXI.Sprite._getGlobalBoundsRecursive`

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-31]

##### now [#now]

`number`

#### Returns [#returns-68]

`void`

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

`PIXI.Sprite._onTouch`

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-32]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-69]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-24]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

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

`PIXI.Sprite.addChild`

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-33]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-70]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-25]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

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

`PIXI.Sprite.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-34]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-71]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

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

`PIXI.Sprite.addEventListener`

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-35]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-72]

`void`

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

`PIXI.Sprite.addEventListener`

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-36]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-73]

`this`

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

`PIXI.Sprite.addListener`

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-37]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-74]

`void`

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

`PIXI.Sprite.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-38]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-75]

`void`

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

`PIXI.Sprite.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-39]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-76]

`void`

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

`PIXI.Sprite.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-40]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-77]

`boolean`

True if the point is within the view's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-26]

* [ViewContainer#bounds](/pixi-vn/index/classes/VideoSprite#bounds) For the bounds used in hit testing
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting global coordinates to local

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

`PIXI.Sprite.containsPoint`

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-41]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-78]

`void`

#### Example [#example-97]

```ts
sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });
```

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

`PIXI.Sprite.destroy`

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-79]

`void`

#### Advanced [#advanced-9]

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

`PIXI.Sprite.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-42]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-80]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-98]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

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

`PIXI.Sprite.dispatchEvent`

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-43]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-81]

`boolean`

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

`PIXI.Sprite.emit`

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-82]

`void`

#### Advanced [#advanced-10]

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

`PIXI.Sprite.enableRenderGroup`

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-83]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

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

`PIXI.Sprite.eventNames`

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-44]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-84]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-99]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-27]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

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

`PIXI.Sprite.getBounds`

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-45]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-85]

`U`

The child at the given index

#### Example [#example-100]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-28]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

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

`PIXI.Sprite.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-46]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-86]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-101]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-29]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

`PIXI.Sprite.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-47]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-87]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-30]

Container#getChildByLabel

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

`PIXI.Sprite.getChildByName`

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-48]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-88]

`number`

The index position of the child container

#### Example [#example-102]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-31]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

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

`PIXI.Sprite.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-49]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-89]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-103]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-32]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

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

`PIXI.Sprite.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-50]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-90]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

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

`PIXI.Sprite.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-51]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-91]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

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

`PIXI.Sprite.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-52]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-92]

`Point`

The updated point

#### Example [#example-105]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-33]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

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

`PIXI.Sprite.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-53]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-93]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

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

`PIXI.Sprite.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-54]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-94]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

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

`PIXI.Sprite.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-95]

`Bounds`

The bounding area

#### Example [#example-108]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-34]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

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

`PIXI.Sprite.getLocalBounds`

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:322

Retrieves the size of the Sprite as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-55]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-96]

`Size`

The size of the Sprite

#### Example [#example-109]

```ts
// Basic size retrieval
const sprite = new Sprite(Texture.from('sprite.png'));
const size = sprite.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
sprite.getSize(reuseSize);
```

#### See [#see-35]

* [Sprite#width](#width) For getting just the width
* [Sprite#height](#height) For getting just the height
* [Sprite#setSize](#setsize) For setting both width and height

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

`PIXI.Sprite.getSize`

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-56]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-97]

`number`

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

`PIXI.Sprite.listenerCount`

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-57]

##### event [#event-3]

`T`

#### Returns [#returns-98]

(...`args`) => `void`\[]

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

`PIXI.Sprite.listeners`

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-58]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-99]

`this`

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

`PIXI.Sprite.off`

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Sprite.ts:100](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L100)

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-59]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-100]

`this`

#### Implementation of [#implementation-of-11]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`on`](/pixi-vn/index/interfaces/ListenerExtension#on)

#### Overrides [#overrides-4]

`PIXI.Sprite.on`

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-60]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-101]

`this`

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

`PIXI.Sprite.once`

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Sprite.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L262)

#### Returns [#returns-102]

`void`

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-61]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-103]

`this`

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

`PIXI.Sprite.removeAllListeners`

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-62]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-104]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-36]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

`PIXI.Sprite.removeChild`

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-63]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-105]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-37]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

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

`PIXI.Sprite.removeChildAt`

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-64]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-106]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-38]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

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

`PIXI.Sprite.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-65]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-107]

`void`

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

`PIXI.Sprite.removeEventListener`

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-66]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-108]

`void`

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

`PIXI.Sprite.removeEventListener`

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-109]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-39]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

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

`PIXI.Sprite.removeFromParent`

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-67]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-110]

`this`

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

`PIXI.Sprite.removeListener`

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-68]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-111]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-40]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

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

`PIXI.Sprite.reparentChild`

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-69]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-112]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-41]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

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

`PIXI.Sprite.reparentChildAt`

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-70]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-113]

`void`

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

`PIXI.Sprite.replaceChild`

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-71]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-114]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-42]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

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

`PIXI.Sprite.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-72]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-115]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-43]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

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

`PIXI.Sprite.setFromMatrix`

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-73]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-116]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-44]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

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

`PIXI.Sprite.setMask`

***

### setMemory() [#setmemory]

> **setMemory**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/Sprite.ts:87](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L87)

This method set the memory of the canvas element.

#### Parameters [#parameters-74]

##### value [#value-26]

[`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory) | `Memory`

#### Returns [#returns-117]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Implementation of [#implementation-of-12]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`setMemory`](/pixi-vn/index/classes/CanvasBaseItem#setmemory)

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:353

Sets the size of the Sprite to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-75]

##### value [#value-27]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-118]

`void`

#### Example [#example-119]

```ts
// Basic size setting
const sprite = new Sprite(Texture.from('sprite.png'));
sprite.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
sprite.setSize(100); // Sets both width and height to 100

// Set size with object
sprite.setSize({
    width: 200,
    height: 300
});

// Reset to texture size
sprite.setSize(
    sprite.texture.orig.width,
    sprite.texture.orig.height
);
```

#### See [#see-45]

* [Sprite#width](#width) For setting width only
* [Sprite#height](#height) For setting height only
* [Sprite#texture](#texture) For the source dimensions

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

`PIXI.Sprite.setSize`

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-76]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-119]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-46]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

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

`PIXI.Sprite.swapChildren`

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-77]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-120]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-47]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

`PIXI.Sprite.toGlobal`

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-78]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-121]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-48]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

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

`PIXI.Sprite.toLocal`

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-122]

`void`

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

`PIXI.Sprite.unload`

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-123]

`void`

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

`PIXI.Sprite.updateLocalTransform`

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-79]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-124]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-49]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

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

`PIXI.Sprite.updateTransform`

***

### from() [#from-1]

> `static` **from**(`source`, `skipCache?`): `Sprite`\<`any`>

Defined in: [src/canvas/components/Sprite.ts:90](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L90)

Creates a new sprite based on a source texture, image, video, or canvas element.
This is a convenience method that automatically creates and manages textures.

#### Parameters [#parameters-80]

##### source [#source]

`Texture`\<`TextureSource`\<`any`>> | [`TextureSourceLike`](/pixi-vn/index/type-aliases/TextureSourceLike)

The source to create the sprite from. Can be a path to an image, a texture,
or any valid texture source (canvas, video, etc.)

##### skipCache? [#skipcache]

`boolean`

Whether to skip adding to the texture cache when creating a new texture

#### Returns [#returns-125]

`Sprite`\<`any`>

A new sprite based on the source

#### Example [#example-124]

```ts
// Create from path or URL
const sprite = Sprite.from('assets/image.png');

// Create from existing texture
const sprite = Sprite.from(texture);

// Create from canvas
const canvas = document.createElement('canvas');
const sprite = Sprite.from(canvas, true); // Skip caching new texture
```

#### See [#see-50]

* Texture.from For texture creation details
* [Assets](/pixi-vn/index/variables/Assets) For asset loading and management

#### Overrides [#overrides-5]

`PIXI.Sprite.from`

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-81]

##### source [#source-1]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-126]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

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

`PIXI.Sprite.mixin`


# Class: StoredClassModel (/pixi-vn/index/classes/StoredClassModel)



Defined in: [src/storage/classes/StoredClassModel.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L33)

StoredClassModel is a abstract class that contains the methods to store a class in the game.
I suggest you extend this class to create your own stored class.

## Example [#example]

```ts
export class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
    constructor(id: string, props: CharacterBaseModelProps) {
        super("___character___", id)
        this.defaultName = props.name
        this.defaultSurname = props.surname
    }
    readonly defaultName: string = ""
    get name(): string {
        return this.getStorageProperty<string>("name") || this.defaultName
    }
    set name(value: string) {
        this.setStorageProperty("name", value)
    }
    readonly defaultSurname?: string
    get surname(): string | undefined {
        return this.getStorageProperty<string>("surname") || this.defaultSurname
    }
    set surname(value: string | undefined) {
        this.setStorageProperty("surname", value)
    }
}
```

## Extended by [#extended-by]

* [`CharacterStoredClass`](/pixi-vn/index/classes/CharacterStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new StoredClassModel**(`categoryId`, `id`): `StoredClassModel`

Defined in: [src/storage/classes/StoredClassModel.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L38)

#### Parameters [#parameters]

##### categoryId [#categoryid]

`string`

The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.

##### id [#id]

`string`

The id of instance of the class. This id must be unique for the category.

#### Returns [#returns]

`StoredClassModel`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/storage/classes/StoredClassModel.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L63)

Is id of the stored class. is unique for this class.

## Methods [#methods]

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: [src/storage/classes/StoredClassModel.ts:80](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L80)

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

#### Parameters [#parameters-1]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string` = `...`

The id of the instance to get the property.

#### Returns [#returns-1]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L43)

#### Parameters [#parameters-2]

##### oldCategoryId? [#oldcategoryid]

`string` = `...`

#### Returns [#returns-2]

`void`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: [src/storage/classes/StoredClassModel.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/classes/StoredClassModel.ts#L71)

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-3]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-3]

`void`


# Class: Text (/pixi-vn/index/classes/Text)



Defined in: [src/canvas/components/Text.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L34)

This class is a extension of the [PIXI.Text class](https://pixijs.com/8.x/examples/text/pixi-text), it has the same properties and methods,
but it has the ability to be saved and loaded by the Pixi’VN library.

## Example [#example]

```ts
const text = new Text();
text.text = "Hello World"
canvas.add("text", text);
```

## Extends [#extends]

* `Text`

## Implements [#implements]

* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<[`TextMemory`](/pixi-vn/index/interfaces/TextMemory)>
* [`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension)
* [`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Text**(`options?`): `Text`

Defined in: [src/canvas/components/Text.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L38)

#### Parameters [#parameters]

##### options? [#options]

[`TextOptions`](/pixi-vn/index/interfaces/TextOptions)

#### Returns [#returns]

`Text`

#### Overrides [#overrides]

`PIXI.Text.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

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

`PIXI.Text.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

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

`PIXI.Text.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

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

`PIXI.Text.__devtoolLocked`

***

### \_anchor [#_anchor]

\> **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:241

**`Internal`**

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

`Text`.[`_anchor`](#_anchor)

***

### \_autoResolution [#_autoresolution]

\> **\_autoResolution**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:245

**`Internal`**

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

`Text`.[`_autoResolution`](#_autoresolution)

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

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

`PIXI.Text._bounds`

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

#### Inherited from [#inherited-from-6]

`PIXI.Text._boundsDirty`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-7]

`PIXI.Text._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-8]

`PIXI.Text._cy`

***

### \_didTextUpdate [#_didtextupdate]

\> **\_didTextUpdate**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:249

**`Internal`**

#### Inherited from [#inherited-from-9]

`Text`.[`_didTextUpdate`](#_didtextupdate)

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

#### Inherited from [#inherited-from-10]

`PIXI.Text._gcData`

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

#### Inherited from [#inherited-from-11]

`PIXI.Text._gcLastUsed`

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

#### Inherited from [#inherited-from-12]

`PIXI.Text._gpuData`

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

#### Inherited from [#inherited-from-13]

`PIXI.Text._lastUsed`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-14]

`PIXI.Text._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-15]

`PIXI.Text._position`

***

### \_resolution [#_resolution]

\> **\_resolution**: `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:243

**`Internal`**

#### Inherited from [#inherited-from-16]

`Text`.[`_resolution`](#_resolution)

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

#### Inherited from [#inherited-from-17]

`PIXI.Text._roundPixels`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-18]

`PIXI.Text._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-19]

`PIXI.Text._skew`

***

### \_style [#_style]

\> **\_style**: `TextStyle`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:247

**`Internal`**

#### Inherited from [#inherited-from-20]

`PIXI.Text._style`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-21]

`PIXI.Text._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-22]

`PIXI.Text._sy`

***

### \_text [#_text]

\> `protected` **\_text**: `string`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:250

#### Inherited from [#inherited-from-23]

`Text`.[`_text`](#_text)

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-24]

`PIXI.Text._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-25]

`PIXI.Text.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-26]

`PIXI.Text.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-27]

`PIXI.Text.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-28]

`PIXI.Text.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-29]

`PIXI.Text.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-30]

`PIXI.Text.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-31]

`PIXI.Text.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

#### Inherited from [#inherited-from-32]

`PIXI.Text.allowChildren`

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-33]

`PIXI.Text.autoGarbageCollect`

***

### autoGenerateMipmaps? [#autogeneratemipmaps]

\> `optional` **autoGenerateMipmaps?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:159

Whether to generate mipmaps for the text texture.
Improves rendering quality when the text is scaled down.
\> \[!NOTE] Text is not updated when this property is updated,
\> you must update the text manually by calling `text.onViewUpdate()`

#### Default [#default-7]

```ts
undefined - Falls back to TextureSource.defaultOptions.autoGenerateMipmaps
```

#### Inherited from [#inherited-from-34]

`PIXI.Text.autoGenerateMipmaps`

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:239

**`Internal`**

#### Inherited from [#inherited-from-35]

`Text`.[`batched`](#batched)

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-36]

`PIXI.Text.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-37]

`PIXI.Text.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-38]

`PIXI.Text.cacheAsTexture`

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

#### Inherited from [#inherited-from-39]

`PIXI.Text.canBundle`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-40]

`PIXI.Text.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-8]

```ts
false
```

#### Inherited from [#inherited-from-41]

`PIXI.Text.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-9]

```ts
true
```

#### Inherited from [#inherited-from-42]

`PIXI.Text.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-10]

```ts
null
```

#### Inherited from [#inherited-from-43]

`PIXI.Text.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-11]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-44]

`PIXI.Text.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-45]

`PIXI.Text.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-12]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

#### Inherited from [#inherited-from-46]

`PIXI.Text.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-47]

`PIXI.Text.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-48]

`PIXI.Text.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

#### Inherited from [#inherited-from-49]

`PIXI.Text.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-50]

`PIXI.Text.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-51]

`PIXI.Text.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-52]

`PIXI.Text.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-53]

`PIXI.Text.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-54]

`PIXI.Text.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-55]

`PIXI.Text.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-56]

`PIXI.Text.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-57]

`PIXI.Text.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-13]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-58]

`PIXI.Text.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

#### Inherited from [#inherited-from-59]

`PIXI.Text.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-60]

`PIXI.Text.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-62]

`PIXI.Text.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-63]

`PIXI.Text.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-64]

`PIXI.Text.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-65]

`PIXI.Text.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-66]

`PIXI.Text.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

#### Inherited from [#inherited-from-67]

`PIXI.Text.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-68]

`PIXI.Text.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-69]

`PIXI.Text.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-70]

`PIXI.Text.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Text.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L63)

#### Implementation of [#implementation-of]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`onEventsHandlers`](/pixi-vn/index/interfaces/ListenerExtension#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-71]

`PIXI.Text.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-72]

`PIXI.Text.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-73]

`PIXI.Text.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-74]

`PIXI.Text.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-75]

`PIXI.Text.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-76]

`PIXI.Text.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-77]

`PIXI.Text.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-78]

`PIXI.Text.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-79]

`PIXI.Text.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-80]

`PIXI.Text.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-81]

`PIXI.Text.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-82]

`PIXI.Text.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-83]

`PIXI.Text.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-84]

`PIXI.Text.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-85]

`PIXI.Text.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-86]

`PIXI.Text.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-87]

`PIXI.Text.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-88]

`PIXI.Text.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-89]

`PIXI.Text.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-90]

`PIXI.Text.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-91]

`PIXI.Text.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-92]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-93]

`PIXI.Text.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-94]

`PIXI.Text.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-95]

`PIXI.Text.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-96]

`PIXI.Text.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-97]

`PIXI.Text.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-98]

`PIXI.Text.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-99]

`PIXI.Text.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-100]

`PIXI.Text.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-101]

`PIXI.Text.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-102]

`PIXI.Text.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-103]

`PIXI.Text.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-104]

`PIXI.Text.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-105]

`PIXI.Text.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_TEXT_ID`

Defined in: [src/canvas/components/Text.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L50)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Implementation of [#implementation-of-1]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`pixivnId`](/pixi-vn/index/classes/CanvasBaseItem#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-106]

`PIXI.Text.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:145

**`Internal`**

#### Inherited from [#inherited-from-107]

`PIXI.Text.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-49]

```ts
false
```

#### Inherited from [#inherited-from-108]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

#### Inherited from [#inherited-from-109]

`PIXI.Text.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-50]

```ts
false
@internal
```

#### Inherited from [#inherited-from-110]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-51]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-111]

`PIXI.Text.tabIndex`

***

### textureStyle? [#texturestyle]

\> `optional` **textureStyle?**: `TextureStyle`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:151

Optional texture style to use for the text. Only `scaleMode` is read, when a new texture is
generated for the text (a text, style or resolution change).

#### Advanced [#advanced-7]

#### Inherited from [#inherited-from-112]

`PIXI.Text.textureStyle`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-113]

`PIXI.Text.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-114]

`PIXI.Text.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-115]

`PIXI.Text.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-52]

```ts
0
```

#### Inherited from [#inherited-from-116]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-117]

`PIXI.Text.prefixed`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Text.ts:103](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L103)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:91](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L91)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-2]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-53]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

#### Inherited from [#inherited-from-118]

`PIXI.Text.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:278

The anchor point of the text that controls the origin point for positioning and rotation.
Can be a number (same value for x/y) or a PointData object.

* (0,0) is top-left
* (0.5,0.5) is center
* (1,1) is bottom-right

```ts
// Set anchor to center
const text = new Text({
    text: 'Hello Pixi!',
    anchor: 0.5 // Same as { x: 0.5, y: 0.5 }
});
// Set anchor to top-left
const text2 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 0, y: 0 } // Top-left corner
});
// Set anchor to bottom-right
const text3 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 1, y: 1 } // Bottom-right corner
});
```

##### Default [#default-54]

```ts
{ x: 0, y: 0 }
```

##### Returns [#returns-10]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:279

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

#### Inherited from [#inherited-from-119]

`PIXI.Text.anchor`

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-120]

`PIXI.Text.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-55]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-121]

`PIXI.Text.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-68]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-16]

`Bounds`

The rectangular bounds of the view

#### Inherited from [#inherited-from-122]

`PIXI.Text.bounds`

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-17]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-18]

`void`

#### Inherited from [#inherited-from-123]

`PIXI.Text.filters`

***

### height [#height]

#### Get Signature [#get-signature-7]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:401

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-71]

```ts
// Set height directly
texture.height = 200;
console.log(texture.scale.y); // Scale adjusted to match height

// For better performance when setting both width and height
texture.setSize(300, 400); // Avoids recalculating bounds twice
```

##### Returns [#returns-19]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:402

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-72]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-124]

`PIXI.Text.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-8]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-8]

##### Returns [#returns-21]

`boolean`

#### Inherited from [#inherited-from-125]

`PIXI.Text.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-9]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-9]

##### Returns [#returns-22]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-23]

`void`

#### Inherited from [#inherited-from-126]

`PIXI.Text.isRenderGroup`

***

### memory [#memory]

#### Get Signature [#get-signature-10]

\> **get** **memory**(): [`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

Defined in: [src/canvas/components/Text.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L51)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-24]

[`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

#### Implementation of [#implementation-of-3]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`memory`](/pixi-vn/index/classes/CanvasBaseItem#memory)

***

### origin [#origin]

#### Get Signature [#get-signature-11]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-73]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-25]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-127]

`PIXI.Text.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-12]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Text.ts:174](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L174)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-27]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:162](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L162)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-28]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-4]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-13]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Text.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L180)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-29]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Text.ts:183](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L183)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-30]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-5]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-14]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Text.ts:189](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L189)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-31]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Text.ts:192](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L192)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-32]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Implementation of [#implementation-of-6]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-15]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-74]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-33]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-14]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-34]

`void`

#### Inherited from [#inherited-from-128]

`PIXI.Text.pivot`

***

### position [#position]

#### Get Signature [#get-signature-16]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Text.ts:264](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L264)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-75]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-35]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:267](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L267)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-36]

`void`

#### Overrides [#overrides-1]

`PIXI.Text.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-17]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Text.ts:206](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L206)

##### Returns [#returns-37]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:216](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L216)

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-38]

`void`

#### Implementation of [#implementation-of-7]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionInfo`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-18]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Text.ts:198](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L198)

##### Returns [#returns-39]

`"pixel"` | `"percentage"` | `"align"`

#### Implementation of [#implementation-of-8]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`positionType`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-19]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-77]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-56]

```ts
true
```

##### See [#see-19]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-40]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-41]

`void`

#### Inherited from [#inherited-from-129]

`PIXI.Text.renderable`

***

### resolution [#resolution]

#### Get Signature [#get-signature-20]

\> **get** **resolution**(): `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:327

##### Returns [#returns-42]

`number`

#### Set Signature [#set-signature-16]

\> **set** **resolution**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:326

The resolution/device pixel ratio for rendering.
Higher values result in sharper text at the cost of performance.
Set to null for auto-resolution based on device.

##### Example [#example-78]

```ts
const text = new Text({
    text: 'Hello Pixi!',
    resolution: 2 // High DPI for sharper text
});
const autoResText = new Text({
    text: 'Auto Resolution',
    resolution: null // Use device's pixel ratio
});
```

##### Default [#default-57]

```ts
null
```

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-43]

`void`

#### Inherited from [#inherited-from-130]

`PIXI.Text.resolution`

***

### rotation [#rotation]

#### Get Signature [#get-signature-21]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-79]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-44]

`number`

#### Set Signature [#set-signature-17]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-19]

###### value [#value-15]

`number`

##### Returns [#returns-45]

`void`

#### Inherited from [#inherited-from-131]

`PIXI.Text.rotation`

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-22]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-80]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-58]

```ts
false
```

##### Returns [#returns-46]

`boolean`

#### Set Signature [#set-signature-18]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-20]

###### value [#value-16]

`boolean`

##### Returns [#returns-47]

`void`

#### Inherited from [#inherited-from-132]

`PIXI.Text.roundPixels`

***

### scale [#scale]

#### Get Signature [#get-signature-23]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-81]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-48]

`ObservablePoint`

#### Set Signature [#set-signature-19]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-21]

###### value [#value-17]

`string` | `number` | `PointData`

##### Returns [#returns-49]

`void`

#### Inherited from [#inherited-from-133]

`PIXI.Text.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-24]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-82]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-59]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-50]

`ObservablePoint`

#### Set Signature [#set-signature-20]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-22]

###### value [#value-18]

`PointData`

##### Returns [#returns-51]

`void`

#### Inherited from [#inherited-from-134]

`PIXI.Text.skew`

***

### style [#style]

#### Get Signature [#get-signature-25]

\> **get** **style**(): `TEXT_STYLE`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:328

##### Returns [#returns-52]

`TEXT_STYLE`

#### Set Signature [#set-signature-21]

\> **set** **style**(`style`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:374

The style configuration for the text.
Can be a TextStyle instance or a configuration object.
Supports canvas text styles, HTML text styles, and bitmap text styles.

##### Example [#example-83]

````ts
const text = new Text({
    text: 'Styled Text',
    style: {
        fontSize: 24,
        fill: 0xff1010, // Red color
        fontFamily: 'Arial',
        align: 'center', // Center alignment
        stroke: { color: '#4a1850', width: 5 }, // Purple stroke
        dropShadow: {
            color: '#000000', // Black shadow
            blur: 4, // Shadow blur
            distance: 6 // Shadow distance
        }
    }
});
const htmlText = new HTMLText({
    text: 'HTML Styled Text',
    style: {
        fontSize: '20px',
        fill: 'blue',
        fontFamily: 'Verdana',
    }
});
const bitmapText = new BitmapText({
    text: 'Bitmap Styled Text',
    style: {
        fontName: 'Arial',
        fontSize: 32,
    }
})

// Update style dynamically
text.style = {
    fontSize: 30, // Change font size
    fill: 0x00ff00, // Change color to green
    align: 'right', // Change alignment to right
    stroke: { color: '#000000', width: 2 }, // Add black stroke
}

##### Parameters

###### style

`TEXT_STYLE` \| `TEXT_STYLE_OPTIONS` \| `Partial`\<`TEXT_STYLE`\>

##### Returns

`void`

#### Inherited from

`PIXI.Text.style`

***

### styleKey

#### Get Signature

> **get** **styleKey**(): `string`

Defined in: node\_modules/pixi.js/lib/scene/text/AbstractText.d.ts:487

Returns a unique key for this instance.
This key is used for caching.

##### Returns

`string`

Unique key for the instance

#### Inherited from

`Text`.[`styleKey`](#stylekey)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: node\_modules/pixi.js/lib/scene/text/AbstractText.d.ts:308

##### Returns

`string`

#### Set Signature

> **set** **text**(`value`): `void`

Defined in: node\_modules/pixi.js/lib/scene/text/AbstractText.d.ts:307

The text content to display. Use '\n' for line breaks.
Accepts strings, numbers, or objects with toString() method.

##### Example

```ts
const text = new Text({
    text: 'Hello Pixi!',
});
const multilineText = new Text({
    text: 'Line 1\nLine 2\nLine 3',
});
const numberText = new Text({
    text: 12345, // Will be converted to '12345'
});
const objectText = new Text({
    text: { toString: () =&gt; 'Object Text' }, // Custom toString
});

// Update text dynamically
text.text = 'Updated Text'; // Re-renders with new text
text.text = 67890; // Updates to '67890'
text.text = { toString: () =&gt; 'Dynamic Text' }; // Uses custom toString method
// Clear text
text.text = ''; // Clears the text
````

##### Default [#default-60]

```ts
''
```

##### Parameters [#parameters-23]

###### value [#value-19]

`TextString`

##### Returns [#returns-53]

`void`

#### Inherited from [#inherited-from-135]

`PIXI.Text.text`

***

### tint [#tint]

#### Get Signature [#get-signature-26]

> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-84]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-61]

```ts
0xFFFFFF
```

##### See [#see-20]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-54]

`number`

#### Set Signature [#set-signature-22]

> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-24]

###### value [#value-20]

`ColorSource`

##### Returns [#returns-55]

`void`

#### Inherited from [#inherited-from-136]

`PIXI.Text.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-27]

> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-85]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-62]

```ts
true
```

##### See [#see-21]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-56]

`boolean`

#### Set Signature [#set-signature-23]

> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-25]

###### value [#value-21]

`boolean`

##### Returns [#returns-57]

`void`

#### Inherited from [#inherited-from-137]

`PIXI.Text.visible`

***

### width [#width]

#### Get Signature [#get-signature-28]

> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:387

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-86]

```ts
// Set width directly
texture.width = 200;
console.log(texture.scale.x); // Scale adjusted to match width

// For better performance when setting both width and height
texture.setSize(300, 400); // Avoids recalculating bounds twice
```

##### Returns [#returns-58]

`number`

#### Set Signature [#set-signature-24]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:388

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-59]

`void`

#### Inherited from [#inherited-from-138]

`PIXI.Text.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-29]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-22]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-60]

`Matrix`

#### Inherited from [#inherited-from-139]

`PIXI.Text.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-30]

> **get** **x**(): `number`

Defined in: [src/canvas/components/Text.ts:272](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L272)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-61]

`number`

#### Set Signature [#set-signature-25]

> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:275](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L275)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-62]

`void`

#### Overrides [#overrides-2]

`PIXI.Text.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-31]

> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Text.ts:131](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L131)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-63]

`number`

#### Set Signature [#set-signature-26]

> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:125](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L125)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-28]

###### value [#value-24]

`number`

##### Returns [#returns-64]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-9]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-32]

> **get** **y**(): `number`

Defined in: [src/canvas/components/Text.ts:280](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L280)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-65]

`number`

#### Set Signature [#set-signature-27]

> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:283](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L283)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-29]

###### value [#value-25]

`number`

##### Returns [#returns-66]

`void`

#### Overrides [#overrides-3]

`PIXI.Text.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-33]

> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Text.ts:149](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L149)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-67]

`number`

#### Set Signature [#set-signature-28]

> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Text.ts:143](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L143)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-30]

###### value [#value-26]

`number`

##### Returns [#returns-68]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Implementation of [#implementation-of-10]

[`AdditionalPositionsExtension`](/pixi-vn/index/interfaces/AdditionalPositionsExtension).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtension#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-31]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-69]

`void`

#### Inherited from [#inherited-from-140]

`PIXI.Text._getGlobalBoundsRecursive`

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-32]

##### now [#now]

`number`

#### Returns [#returns-70]

`void`

#### Inherited from [#inherited-from-141]

`PIXI.Text._onTouch`

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-33]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-71]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-23]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

#### Inherited from [#inherited-from-142]

`PIXI.Text.addChild`

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-1]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-34]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-72]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-24]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

#### Inherited from [#inherited-from-143]

`PIXI.Text.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-2]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-35]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-73]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-144]

`PIXI.Text.addEventListener`

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-36]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-74]

`void`

##### Inherited from [#inherited-from-145]

`PIXI.Text.addEventListener`

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-3]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-37]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-75]

`this`

#### Inherited from [#inherited-from-146]

`PIXI.Text.addListener`

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-38]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-76]

`void`

#### Inherited from [#inherited-from-147]

`PIXI.Text.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-39]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-77]

`void`

#### Inherited from [#inherited-from-148]

`PIXI.Text.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-40]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-78]

`void`

#### Inherited from [#inherited-from-149]

`PIXI.Text.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:468

Checks if the object contains the given point in local coordinates.
Uses the text's bounds for hit testing.

#### Parameters [#parameters-41]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-79]

`boolean`

True if the point is within the text's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = text.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-25]

[Container#toLocal](/pixi-vn/index/classes/Container#tolocal) For converting global coordinates to local

#### Inherited from [#inherited-from-150]

`PIXI.Text.containsPoint`

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:481

Destroys this text renderable and optionally its style texture.

#### Parameters [#parameters-42]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-80]

`void`

#### Example [#example-97]

```ts
// Destroys the text and its style
text.destroy({ style: true, texture: true, textureSource: true });
text.destroy(true);
text.destroy() // Destroys the text, but not its style
```

#### Inherited from [#inherited-from-151]

`PIXI.Text.destroy`

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-81]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-152]

`PIXI.Text.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-43]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-82]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-98]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-153]

`PIXI.Text.dispatchEvent`

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-44]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-83]

`boolean`

#### Inherited from [#inherited-from-154]

`PIXI.Text.emit`

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-84]

`void`

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-155]

`PIXI.Text.enableRenderGroup`

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-85]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-156]

`PIXI.Text.eventNames`

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-45]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-86]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-99]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-26]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-157]

`PIXI.Text.getBounds`

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-5]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-46]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-87]

`U`

The child at the given index

#### Example [#example-100]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-27]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

#### Inherited from [#inherited-from-158]

`PIXI.Text.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-47]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-88]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-101]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-28]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

#### Inherited from [#inherited-from-159]

`PIXI.Text.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-48]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-89]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-29]

Container#getChildByLabel

#### Inherited from [#inherited-from-160]

`PIXI.Text.getChildByName`

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-49]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-90]

`number`

The index position of the child container

#### Example [#example-102]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-30]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

#### Inherited from [#inherited-from-161]

`PIXI.Text.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-50]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-91]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-103]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-31]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

#### Inherited from [#inherited-from-162]

`PIXI.Text.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-51]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-92]

`Bounds`

The computed bounds.

#### Advanced [#advanced-12]

#### Inherited from [#inherited-from-163]

`PIXI.Text.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-52]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-93]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-164]

`PIXI.Text.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-53]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-94]

`Point`

The updated point

#### Example [#example-105]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-32]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

#### Inherited from [#inherited-from-165]

`PIXI.Text.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-54]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-95]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-166]

`PIXI.Text.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-55]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-96]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-167]

`PIXI.Text.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-97]

`Bounds`

The bounding area

#### Example [#example-108]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-33]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-168]

`PIXI.Text.getLocalBounds`

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:426

Retrieves the size of the Text as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-56]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-98]

`Size`

The size of the Sprite

#### Example [#example-109]

```ts
// Basic size retrieval
const text = new Text({
    text: 'Hello Pixi!',
    style: { fontSize: 24 }
});
const size = text.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
text.getSize(reuseSize);
```

#### See [#see-34]

* [Text#width](#width) For getting just the width
* [Text#height](#height) For getting just the height
* [Text#setSize](#setsize) For setting both width and height

#### Inherited from [#inherited-from-169]

`PIXI.Text.getSize`

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-57]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-99]

`number`

#### Inherited from [#inherited-from-170]

`PIXI.Text.listenerCount`

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-58]

##### event [#event-3]

`T`

#### Returns [#returns-100]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-171]

`PIXI.Text.listeners`

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-7]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-59]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-101]

`this`

#### Inherited from [#inherited-from-172]

`PIXI.Text.off`

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Text.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L64)

Add a listener for a given event.

#### Type Parameters [#type-parameters-8]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-60]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-102]

`this`

#### Implementation of [#implementation-of-11]

[`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension).[`on`](/pixi-vn/index/interfaces/ListenerExtension#on)

#### Overrides [#overrides-4]

`PIXI.Text.on`

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-61]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-103]

`this`

#### Inherited from [#inherited-from-173]

`PIXI.Text.once`

***

### onViewUpdate() [#onviewupdate]

> **onViewUpdate**(): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:470

**`Internal`**

#### Returns [#returns-104]

`void`

#### Inherited from [#inherited-from-174]

`PIXI.Text.onViewUpdate`

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Text.ts:225](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L225)

#### Returns [#returns-105]

`void`

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-62]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-106]

`this`

#### Inherited from [#inherited-from-175]

`PIXI.Text.removeAllListeners`

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-10]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-63]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-107]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-35]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-176]

`PIXI.Text.removeChild`

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-11]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-64]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-108]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-36]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-177]

`PIXI.Text.removeChildAt`

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-65]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-109]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-37]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

#### Inherited from [#inherited-from-178]

`PIXI.Text.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-12]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-66]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-110]

`void`

##### Inherited from [#inherited-from-179]

`PIXI.Text.removeEventListener`

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-67]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-111]

`void`

##### Inherited from [#inherited-from-180]

`PIXI.Text.removeEventListener`

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-112]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-38]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

#### Inherited from [#inherited-from-181]

`PIXI.Text.removeFromParent`

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-13]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-68]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-113]

`this`

#### Inherited from [#inherited-from-182]

`PIXI.Text.removeListener`

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-14]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-69]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-114]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-39]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

#### Inherited from [#inherited-from-183]

`PIXI.Text.reparentChild`

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-70]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-115]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-40]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

#### Inherited from [#inherited-from-184]

`PIXI.Text.reparentChildAt`

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-16]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-71]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-116]

`void`

#### Inherited from [#inherited-from-185]

`PIXI.Text.replaceChild`

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-72]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-117]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-41]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

#### Inherited from [#inherited-from-186]

`PIXI.Text.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-73]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-118]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-42]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-187]

`PIXI.Text.setFromMatrix`

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-74]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-119]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-43]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-188]

`PIXI.Text.setMask`

***

### setMemory() [#setmemory]

> **setMemory**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/Text.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Text.ts#L59)

This method set the memory of the canvas element.

#### Parameters [#parameters-75]

##### value [#value-27]

[`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

#### Returns [#returns-120]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Implementation of [#implementation-of-12]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`setMemory`](/pixi-vn/index/classes/CanvasBaseItem#setmemory)

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:453

Sets the size of the Text to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-76]

##### value [#value-28]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-121]

`void`

#### Example [#example-119]

```ts
// Basic size setting
const text = new Text({
   text: 'Hello Pixi!',
   style: { fontSize: 24 }
});
text.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
text.setSize(100); // Sets both width and height to 100

// Set size with object
text.setSize({
    width: 200,
    height: 300
});
```

#### See [#see-44]

* [Text#width](#width) For setting width only
* [Text#height](#height) For setting height only

#### Inherited from [#inherited-from-189]

`PIXI.Text.setSize`

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-17]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-77]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-122]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-45]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

#### Inherited from [#inherited-from-190]

`PIXI.Text.swapChildren`

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-18]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-78]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-123]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-46]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

#### Inherited from [#inherited-from-191]

`PIXI.Text.toGlobal`

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-19]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-79]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-124]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-47]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

#### Inherited from [#inherited-from-192]

`PIXI.Text.toLocal`

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-125]

`void`

#### Inherited from [#inherited-from-193]

`PIXI.Text.unload`

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-126]

`void`

#### Inherited from [#inherited-from-194]

`PIXI.Text.updateLocalTransform`

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-80]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-127]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-48]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

#### Inherited from [#inherited-from-195]

`PIXI.Text.updateTransform`

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-81]

##### source [#source]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-128]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

#### Inherited from [#inherited-from-196]

`PIXI.Text.mixin`


# Abstract Class: TickerBase<TArgs> (/pixi-vn/index/classes/TickerBase)



Defined in: [src/tickers/classes/TickerBase.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L44)

A class is used to create a ticker element to add into a Pixi Application.
You can use `tickers.add()` (from `@drincs/pixi-vn`) to add this element into the application.
This class should be extended and the fn method should be overridden.
You must use the [tickerDecorator](/pixi-vn/index/functions/tickerDecorator) to register the ticker in the game.
In Ren'Py is a transform.

## Example [#example]

```ts
\@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
export class RotateTicker extends TickerBase<{ speed?: number }> {
    override fn(
        t: TickerValue, // the ticker that is calling this method
        args: { // the arguments that you passed when you added the ticker
            speed?: number,
        },
        aliases: string[], // the aliases of the canvas elements that are connected to this ticker
        tickerId: string, // the id of the ticker. You can use this to get the ticker from tickers.currentTickers
    ): void {
        let speed = args.speed === undefined ? 0.1 : args.speed
        aliases.forEach((alias) => {
                let element = canvas.find(alias)
                if (element && element instanceof Container) {
                    if (clockwise)
                        element.rotation += speed * t.deltaTime
                    else
                        element.rotation -= speed * t.deltaTime
                }
            })
    }
}
```

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

The type of the arguments that you want to pass to the ticker.

## Implements [#implements]

* [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new TickerBase**\<`TArgs`>(`args`, `options?`): `TickerBase`\<`TArgs`>

Defined in: [src/tickers/classes/TickerBase.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L49)

#### Parameters [#parameters]

##### args [#args]

`TArgs`

The arguments that you want to pass to the ticker.

##### options? [#options]

The options of the ticker.

###### canvasElementAliases? [#canvaselementaliases]

`string`\[]

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**

```ts
[]
```

###### duration? [#duration]

`number`

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**

```ts
undefined
```

###### id? [#id]

`string`

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**

```ts
undefined
```

###### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the ticker.

**Default**

```ts
UPDATE_PRIORITY.NORMAL
```

#### Returns [#returns]

`TickerBase`\<`TArgs`>

## Properties [#properties]

### alias [#alias]

\> `readonly` **alias**: `string`

Defined in: [src/tickers/classes/TickerBase.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L83)

Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, [RegisteredTickers.getInstance](/pixi-vn/index/namespaces/RegisteredTickers/functions/getInstance)

#### Implementation of [#implementation-of]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`alias`](/pixi-vn/index/interfaces/Ticker#alias)

***

### args [#args-1]

\> **args**: `TArgs`

Defined in: [src/tickers/classes/TickerBase.ts:85](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L85)

Arguments to pass to the ticker

#### Implementation of [#implementation-of-1]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`args`](/pixi-vn/index/interfaces/Ticker#args)

***

### canvasElementAliases [#canvaselementaliases-1]

\> **canvasElementAliases**: `string`\[] = `[]`

Defined in: [src/tickers/classes/TickerBase.ts:89](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L89)

The aliases of the canvas elements that are connected to this ticker

#### Implementation of [#implementation-of-2]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`canvasElementAliases`](/pixi-vn/index/interfaces/Ticker#canvaselementaliases)

***

### duration? [#duration-1]

\> `optional` **duration?**: `number`

Defined in: [src/tickers/classes/TickerBase.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L86)

Duration in seconds to run the ticker

#### Implementation of [#implementation-of-3]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`duration`](/pixi-vn/index/interfaces/Ticker#duration)

***

### fnValue? [#fnvalue]

\> `protected` `optional` **fnValue?**: () => `void`

Defined in: [src/tickers/classes/TickerBase.ts:116](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L116)

#### Returns [#returns-1]

`void`

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: [src/tickers/classes/TickerBase.ts:84](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L84)

The id of the ticker. Must be unique for each ticker instance.

#### Implementation of [#implementation-of-4]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`id`](/pixi-vn/index/interfaces/Ticker#id)

***

### priority? [#priority-1]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/tickers/classes/TickerBase.ts:87](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L87)

Priority of the ticker

#### Implementation of [#implementation-of-5]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`priority`](/pixi-vn/index/interfaces/Ticker#priority)

***

### ticker [#ticker]

\> `protected` **ticker**: [`TickerValue`](/pixi-vn/index/interfaces/TickerValue)

Defined in: [src/tickers/classes/TickerBase.ts:88](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L88)

## Accessors [#accessors]

### paused [#paused]

#### Get Signature [#get-signature]

\> **get** **paused**(): `boolean`

Defined in: [src/tickers/classes/TickerBase.ts:141](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L141)

Checks if the ticker is paused.

##### Returns [#returns-2]

`boolean`

true if the ticker is paused, false otherwise.

Checks if the ticker is paused.

#### Implementation of [#implementation-of-6]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`paused`](/pixi-vn/index/interfaces/Ticker#paused)

## Methods [#methods]

### complete() [#complete]

\> **complete**(`_options?`): `void`

Defined in: [src/tickers/classes/TickerBase.ts:117](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L117)

Completes the animation and applies the final state.

#### Parameters [#parameters-1]

##### \_options? [#_options]

###### ignoreTickerSteps? [#ignoretickersteps]

`boolean`

#### Returns [#returns-3]

`void`

#### Implementation of [#implementation-of-7]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`complete`](/pixi-vn/index/interfaces/Ticker#complete)

***

### fn() [#fn]

\> `abstract` **fn**(`_ticker`, `_args`, `_alias`, `_tickerId`): `void`

Defined in: [src/tickers/classes/TickerBase.ts:110](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L110)

The method that will be called every frame.
This method should be overridden and you can use `canvas.find()` (from `@drincs/pixi-vn/canvas`)
to get the canvas element of the canvas, and edit them.

#### Parameters [#parameters-2]

##### \_ticker [#_ticker]

[`TickerValue`](/pixi-vn/index/interfaces/TickerValue)

The ticker that is calling this method

##### \_args [#_args]

`TArgs`

The arguments that you passed when you added the ticker

##### \_alias [#_alias]

`string` | `string`\[]

The alias of the canvas elements that are connected to this ticker

##### \_tickerId [#_tickerid]

`string`

The id of the ticker. You can use this to get the ticker from `tickers.currentTickers`

#### Returns [#returns-4]

`void`

***

### pause() [#pause]

\> **pause**(): `void`

Defined in: [src/tickers/classes/TickerBase.ts:135](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L135)

Pauses the animation.

#### Returns [#returns-5]

`void`

#### Implementation of [#implementation-of-8]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`pause`](/pixi-vn/index/interfaces/Ticker#pause)

***

### play() [#play]

\> **play**(): `void`

Defined in: [src/tickers/classes/TickerBase.ts:138](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L138)

Plays the animation.

#### Returns [#returns-6]

`void`

#### Implementation of [#implementation-of-9]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`play`](/pixi-vn/index/interfaces/Ticker#play)

***

### start() [#start]

\> **start**(): `void`

Defined in: [src/tickers/classes/TickerBase.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L128)

Starts the ticker. This will start the ticker and begin the animation.

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-10]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`start`](/pixi-vn/index/interfaces/Ticker#start)

***

### stop() [#stop]

\> **stop**(): `void`

Defined in: [src/tickers/classes/TickerBase.ts:120](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/classes/TickerBase.ts#L120)

Stops the animation at its current state, and prevents it from resuming when the animation is played again.

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-11]

[`Ticker`](/pixi-vn/index/interfaces/Ticker).[`stop`](/pixi-vn/index/interfaces/Ticker#stop)


# Class: VideoSprite (/pixi-vn/index/classes/VideoSprite)



Defined in: [src/canvas/components/VideoSprite.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L33)

This class is a extension of the [ImageSprite](/pixi-vn/index/classes/ImageSprite) class, it has the same properties and methods,
but it has some features that make video management easier.
You need to use [load](#load) to show the video in the canvas.
This class is used for functions like [addVideo](/pixi-vn/index/functions/addVideo) and [showWithDissolve](/pixi-vn/index/functions/showWithDissolve).

## Examples [#examples]

```ts
let film = new VideoSprite({
    x: 100,
    y: 100,
}, 'https://pixijs.com/assets/video.mp4')
await film.load()
canvas.add("film", film)
```

```ts
let film = addVideo("film", 'https://pixijs.com/assets/video.mp4')
film.currentTime = 2
await film.load()
```

## Extends [#extends]

* [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`VideoSpriteMemory`](/pixi-vn/index/interfaces/VideoSpriteMemory)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new VideoSprite**(`options?`, `textureAlias?`): `VideoSprite`

Defined in: [src/canvas/components/VideoSprite.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L38)

#### Parameters [#parameters]

##### options? [#options]

`Texture`\<`TextureSource`\<`any`>> | [`VideoSpriteOptions`](/pixi-vn/index/interfaces/VideoSpriteOptions)

The options for the component.

##### textureAlias? [#texturealias]

`string`

The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.

#### Returns [#returns]

`VideoSprite`

#### Overrides [#overrides]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`constructor`](/pixi-vn/index/classes/ImageSprite#constructor)

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`__devtoolIgnore`](/pixi-vn/index/classes/ImageSprite#__devtoolignore)

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`__devtoolIgnoreChildren`](/pixi-vn/index/classes/ImageSprite#__devtoolignorechildren)

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`__devtoolLocked`](/pixi-vn/index/classes/ImageSprite#__devtoollocked)

***

### \_anchor [#_anchor]

\> `readonly` **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:155

**`Internal`**

#### Inherited from [#inherited-from-3]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_anchor`](/pixi-vn/index/classes/ImageSprite#_anchor)

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

#### Inherited from [#inherited-from-4]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_bounds`](/pixi-vn/index/classes/ImageSprite#_bounds)

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

#### Inherited from [#inherited-from-5]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_boundsDirty`](/pixi-vn/index/classes/ImageSprite#_boundsdirty)

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-6]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_cx`](/pixi-vn/index/classes/ImageSprite#_cx)

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-7]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_cy`](/pixi-vn/index/classes/ImageSprite#_cy)

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

#### Inherited from [#inherited-from-8]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_gcData`](/pixi-vn/index/classes/ImageSprite#_gcdata)

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

#### Inherited from [#inherited-from-9]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_gcLastUsed`](/pixi-vn/index/classes/ImageSprite#_gclastused)

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

#### Inherited from [#inherited-from-10]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_gpuData`](/pixi-vn/index/classes/ImageSprite#_gpudata)

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

#### Inherited from [#inherited-from-11]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_lastUsed`](/pixi-vn/index/classes/ImageSprite#_lastused)

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-12]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_pivot`](/pixi-vn/index/classes/ImageSprite#_pivot)

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-13]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_position`](/pixi-vn/index/classes/ImageSprite#_position)

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

#### Inherited from [#inherited-from-14]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_roundPixels`](/pixi-vn/index/classes/ImageSprite#_roundpixels)

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-15]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_scale`](/pixi-vn/index/classes/ImageSprite#_scale)

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-16]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_skew`](/pixi-vn/index/classes/ImageSprite#_skew)

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-17]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_sx`](/pixi-vn/index/classes/ImageSprite#_sx)

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-18]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_sy`](/pixi-vn/index/classes/ImageSprite#_sy)

***

### \_texture [#_texture]

\> **\_texture**: `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:157

**`Internal`**

#### Inherited from [#inherited-from-19]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_texture`](/pixi-vn/index/classes/ImageSprite#_texture)

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-20]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_zIndex`](/pixi-vn/index/classes/ImageSprite#_zindex)

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-21]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessible`](/pixi-vn/index/classes/ImageSprite#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-22]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessibleChildren`](/pixi-vn/index/classes/ImageSprite#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-23]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessibleHint`](/pixi-vn/index/classes/ImageSprite#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessiblePointerEvents`](/pixi-vn/index/classes/ImageSprite#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-25]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessibleText`](/pixi-vn/index/classes/ImageSprite#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-26]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessibleTitle`](/pixi-vn/index/classes/ImageSprite#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-27]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`accessibleType`](/pixi-vn/index/classes/ImageSprite#accessibletype)

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

#### Inherited from [#inherited-from-28]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`allowChildren`](/pixi-vn/index/classes/ImageSprite#allowchildren)

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`autoGarbageCollect`](/pixi-vn/index/classes/ImageSprite#autogarbagecollect)

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:153

**`Internal`**

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`batched`](/pixi-vn/index/classes/ImageSprite#batched)

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-7]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`boundsArea`](/pixi-vn/index/classes/ImageSprite#boundsarea)

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cacheAsBitmap`](/pixi-vn/index/classes/ImageSprite#cacheasbitmap)

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-8]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cacheAsTexture`](/pixi-vn/index/classes/ImageSprite#cacheastexture)

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`canBundle`](/pixi-vn/index/classes/ImageSprite#canbundle)

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-9]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`children`](/pixi-vn/index/classes/ImageSprite#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-10]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cullable`](/pixi-vn/index/classes/ImageSprite#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-11]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cullableChildren`](/pixi-vn/index/classes/ImageSprite#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-12]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cullArea`](/pixi-vn/index/classes/ImageSprite#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-13]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`cursor`](/pixi-vn/index/classes/ImageSprite#cursor)

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`depthOfChildModified`](/pixi-vn/index/classes/ImageSprite#depthofchildmodified)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-14]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`destroyed`](/pixi-vn/index/classes/ImageSprite#destroyed)

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`effects`](/pixi-vn/index/classes/ImageSprite#effects)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-15]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`eventMode`](/pixi-vn/index/classes/ImageSprite#eventmode)

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-16]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`filterArea`](/pixi-vn/index/classes/ImageSprite#filterarea)

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`globalDisplayStatus`](/pixi-vn/index/classes/ImageSprite#globaldisplaystatus)

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`groupAlpha`](/pixi-vn/index/classes/ImageSprite#groupalpha)

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`groupBlendMode`](/pixi-vn/index/classes/ImageSprite#groupblendmode)

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`groupColor`](/pixi-vn/index/classes/ImageSprite#groupcolor)

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-49]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`groupColorAlpha`](/pixi-vn/index/classes/ImageSprite#groupcoloralpha)

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-50]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`groupTransform`](/pixi-vn/index/classes/ImageSprite#grouptransform)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-17]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-51]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`hitArea`](/pixi-vn/index/classes/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](#eventmode)

#### Example [#example-18]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`interactive`](/pixi-vn/index/classes/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-19]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`interactiveChildren`](/pixi-vn/index/classes/ImageSprite#interactivechildren)

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-20]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`isCachedAsTexture`](/pixi-vn/index/classes/ImageSprite#iscachedastexture)

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-21]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`isInteractive`](/pixi-vn/index/classes/ImageSprite#isinteractive)

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`layerParentId`](/pixi-vn/index/classes/ImageSprite#layerparentid)

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`localAlpha`](/pixi-vn/index/classes/ImageSprite#localalpha)

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`localBlendMode`](/pixi-vn/index/classes/ImageSprite#localblendmode)

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`localColor`](/pixi-vn/index/classes/ImageSprite#localcolor)

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-61]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`localDisplayStatus`](/pixi-vn/index/classes/ImageSprite#localdisplaystatus)

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-22]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](#worldtransform) For global transform
* [Container#groupTransform](#grouptransform) For render group transform

#### Inherited from [#inherited-from-62]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`localTransform`](/pixi-vn/index/classes/ImageSprite#localtransform)

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-23]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-63]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`mask`](/pixi-vn/index/classes/ImageSprite#mask)

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-64]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`name`](/pixi-vn/index/classes/ImageSprite#name)

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-65]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onclick`](/pixi-vn/index/classes/ImageSprite#onclick)

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers) = `{}`

Defined in: [src/canvas/components/Sprite.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L99)

ListenerExtension

#### Inherited from [#inherited-from-66]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onEventsHandlers`](/pixi-vn/index/classes/ImageSprite#oneventshandlers)

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-67]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onglobalmousemove`](/pixi-vn/index/classes/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-68]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onglobalpointermove`](/pixi-vn/index/classes/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-69]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-70]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmousedown`](/pixi-vn/index/classes/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-71]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseenter`](/pixi-vn/index/classes/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-72]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseleave`](/pixi-vn/index/classes/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-73]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmousemove`](/pixi-vn/index/classes/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-74]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseout`](/pixi-vn/index/classes/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-75]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseover`](/pixi-vn/index/classes/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-76]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseup`](/pixi-vn/index/classes/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-77]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onmouseupoutside`](/pixi-vn/index/classes/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-78]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointercancel`](/pixi-vn/index/classes/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-79]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerdown`](/pixi-vn/index/classes/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-80]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerenter`](/pixi-vn/index/classes/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-81]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerleave`](/pixi-vn/index/classes/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-82]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointermove`](/pixi-vn/index/classes/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-83]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerout`](/pixi-vn/index/classes/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-84]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerover`](/pixi-vn/index/classes/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-85]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointertap`](/pixi-vn/index/classes/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-86]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerup`](/pixi-vn/index/classes/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-87]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onpointerupoutside`](/pixi-vn/index/classes/ImageSprite#onpointerupoutside)

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-46]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-88]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-89]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onrightclick`](/pixi-vn/index/classes/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-90]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onrightdown`](/pixi-vn/index/classes/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-91]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onrightup`](/pixi-vn/index/classes/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-92]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onrightupoutside`](/pixi-vn/index/classes/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-93]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontap`](/pixi-vn/index/classes/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-94]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontouchcancel`](/pixi-vn/index/classes/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-95]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontouchend`](/pixi-vn/index/classes/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-96]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontouchendoutside`](/pixi-vn/index/classes/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-97]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontouchmove`](/pixi-vn/index/classes/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-98]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`ontouchstart`](/pixi-vn/index/classes/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-99]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`onwheel`](/pixi-vn/index/classes/ImageSprite#onwheel)

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-58]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-100]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`parent`](/pixi-vn/index/classes/ImageSprite#parent)

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-101]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`parentRenderLayer`](/pixi-vn/index/classes/ImageSprite#parentrenderlayer)

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_VIDEO_ID`

Defined in: [src/canvas/components/VideoSprite.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L55)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Overrides [#overrides-1]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`pixivnId`](/pixi-vn/index/classes/ImageSprite#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-102]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`relativeGroupTransform`](/pixi-vn/index/classes/ImageSprite#relativegrouptransform)

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:151

**`Internal`**

#### Inherited from [#inherited-from-103]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`renderPipeId`](/pixi-vn/index/classes/ImageSprite#renderpipeid)

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-59]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-104]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-60]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](#sortablechildren) For enabling automatic sorting
* [Container#zIndex](#zindex) For setting child order

#### Inherited from [#inherited-from-105]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`sortChildren`](/pixi-vn/index/classes/ImageSprite#sortchildren)

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-106]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-61]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-107]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`tabIndex`](/pixi-vn/index/classes/ImageSprite#tabindex)

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-108]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`uid`](/pixi-vn/index/classes/ImageSprite#uid)

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-62]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-109]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`updateCacheTexture`](/pixi-vn/index/classes/ImageSprite#updatecachetexture)

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-110]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`updateTick`](/pixi-vn/index/classes/ImageSprite#updatetick)

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-63]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-111]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-112]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`prefixed`](/pixi-vn/index/classes/ImageSprite#prefixed)

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L140)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L128)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-113]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`align`](/pixi-vn/index/classes/ImageSprite#align)

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-64]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](#visible) For toggling visibility
* [Container#renderable](#renderable) For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

#### Inherited from [#inherited-from-114]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`alpha`](/pixi-vn/index/classes/ImageSprite#alpha)

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:256

The anchor sets the origin point of the sprite. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

* The default is `(0,0)`, this means the sprite's origin is the top left.
* Setting the anchor to `(0.5,0.5)` means the sprite's origin is centered.
* Setting the anchor to `(1,1)` would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-65]

```ts
// Center the anchor point
sprite.anchor = 0.5; // Sets both x and y to 0.5
sprite.position.set(400, 300); // Sprite will be centered at this position

// Set specific x/y anchor points
sprite.anchor = {
    x: 1, // Right edge
    y: 0  // Top edge
};

// Using individual coordinates
sprite.anchor.set(0.5, 1); // Center-bottom

// For rotation around center
sprite.anchor.set(0.5);
sprite.rotation = Math.PI / 4; // 45 degrees around center

// For scaling from center
sprite.anchor.set(0.5);
sprite.scale.set(2); // Scales from center point
```

##### Returns [#returns-10]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:257

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

#### Inherited from [#inherited-from-115]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`anchor`](/pixi-vn/index/classes/ImageSprite#anchor)

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-116]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`angle`](/pixi-vn/index/classes/ImageSprite#angle)

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](#alpha) For transparency
* [Container#tint](#tint) For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-117]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`blendMode`](/pixi-vn/index/classes/ImageSprite#blendmode)

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-68]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-16]

`Bounds`

The rectangular bounds of the view

#### Inherited from [#inherited-from-118]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`bounds`](/pixi-vn/index/classes/ImageSprite#bounds)

***

### currentTime [#currenttime]

#### Get Signature [#get-signature-6]

\> **get** **currentTime**(): `number`

Defined in: [src/canvas/components/VideoSprite.ts:137](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L137)

The current time of the video.

##### Returns [#returns-17]

`number`

#### Set Signature [#set-signature-5]

\> **set** **currentTime**(`value`): `void`

Defined in: [src/canvas/components/VideoSprite.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L140)

##### Parameters [#parameters-7]

###### value [#value-5]

`number`

##### Returns [#returns-18]

`void`

***

### duration [#duration]

#### Get Signature [#get-signature-7]

\> **get** **duration**(): `number` | `undefined`

Defined in: [src/canvas/components/VideoSprite.ts:161](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L161)

The duration of the video.

##### Returns [#returns-19]

`number` | `undefined`

***

### filters [#filters]

#### Get Signature [#get-signature-8]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-20]

readonly `Filter`\[]

#### Set Signature [#set-signature-6]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-8]

###### value [#value-6]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-119]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`filters`](/pixi-vn/index/classes/ImageSprite#filters)

***

### haveEmptyTexture [#haveemptytexture]

#### Get Signature [#get-signature-9]

\> **get** **haveEmptyTexture**(): `boolean`

Defined in: [src/canvas/components/ImageSprite.ts:138](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L138)

Check if the texture is empty.

##### Returns [#returns-22]

`boolean`

A boolean that is true if the texture is empty.

#### Inherited from [#inherited-from-120]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`haveEmptyTexture`](/pixi-vn/index/classes/ImageSprite#haveemptytexture)

***

### height [#height]

#### Get Signature [#get-signature-10]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:300

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-71]

```ts
// Set height directly
sprite.height = 150;
console.log(sprite.scale.y); // Scale adjusted to match height

// Set height while preserving aspect ratio
const ratio = sprite.width / sprite.height;
sprite.height = 200;
sprite.width = 200 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.height = sprite.texture.orig.height;
```

##### Returns [#returns-23]

`number`

#### Set Signature [#set-signature-7]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:301

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-72]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-9]

###### value [#value-7]

`number`

##### Returns [#returns-24]

`void`

#### Inherited from [#inherited-from-121]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`height`](/pixi-vn/index/classes/ImageSprite#height)

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-11]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-25]

`boolean`

#### Inherited from [#inherited-from-122]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`isRenderable`](/pixi-vn/index/classes/ImageSprite#isrenderable)

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-12]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-26]

`boolean`

#### Set Signature [#set-signature-8]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-10]

###### value [#value-8]

`boolean`

##### Returns [#returns-27]

`void`

#### Inherited from [#inherited-from-123]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`isRenderGroup`](/pixi-vn/index/classes/ImageSprite#isrendergroup)

***

### loadIsStarted [#loadisstarted]

#### Get Signature [#get-signature-13]

\> **get** **loadIsStarted**(): `boolean`

Defined in: [src/canvas/components/ImageSprite.ts:96](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L96)

##### Returns [#returns-28]

`boolean`

#### Inherited from [#inherited-from-124]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`loadIsStarted`](/pixi-vn/index/classes/ImageSprite#loadisstarted)

***

### loop [#loop]

#### Get Signature [#get-signature-14]

\> **get** **loop**(): `boolean`

Defined in: [src/canvas/components/VideoSprite.ts:87](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L87)

Set to true if you want the video to loop.

##### Returns [#returns-29]

`boolean`

#### Set Signature [#set-signature-9]

\> **set** **loop**(`value`): `void`

Defined in: [src/canvas/components/VideoSprite.ts:90](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L90)

##### Parameters [#parameters-11]

###### value [#value-9]

`boolean`

##### Returns [#returns-30]

`void`

***

### memory [#memory]

#### Get Signature [#get-signature-15]

\> **get** **memory**(): [`VideoSpriteMemory`](/pixi-vn/index/interfaces/VideoSpriteMemory)

Defined in: [src/canvas/components/VideoSprite.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L56)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-31]

[`VideoSpriteMemory`](/pixi-vn/index/interfaces/VideoSpriteMemory)

#### Overrides [#overrides-2]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`memory`](/pixi-vn/index/classes/ImageSprite#memory-1)

***

### origin [#origin]

#### Get Signature [#get-signature-16]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-73]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-32]

`ObservablePoint`

#### Set Signature [#set-signature-10]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-12]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-33]

`void`

#### Inherited from [#inherited-from-125]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`origin`](/pixi-vn/index/classes/ImageSprite#origin)

***

### paused [#paused]

#### Get Signature [#get-signature-17]

\> **get** **paused**(): `boolean`

Defined in: [src/canvas/components/VideoSprite.ts:101](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L101)

Set to true if you want the video to be paused.

##### Returns [#returns-34]

`boolean`

#### Set Signature [#set-signature-11]

\> **set** **paused**(`value`): `void`

Defined in: [src/canvas/components/VideoSprite.ts:104](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L104)

##### Parameters [#parameters-13]

###### value [#value-11]

`boolean`

##### Returns [#returns-35]

`void`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-18]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/Sprite.ts:211](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L211)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-36]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-12]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L199)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-14]

###### value [#value-12]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-37]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-126]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`percentagePosition`](/pixi-vn/index/classes/ImageSprite#percentageposition)

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-19]

\> **get** **percentageX**(): `number`

Defined in: [src/canvas/components/Sprite.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L217)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-38]

`number`

#### Set Signature [#set-signature-13]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:220](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L220)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-15]

###### \_value [#_value]

`number`

##### Returns [#returns-39]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-127]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`percentageX`](/pixi-vn/index/classes/ImageSprite#percentagex)

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-20]

\> **get** **percentageY**(): `number`

Defined in: [src/canvas/components/Sprite.ts:226](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L226)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-40]

`number`

#### Set Signature [#set-signature-14]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/canvas/components/Sprite.ts:229](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L229)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-16]

###### \_value [#_value-1]

`number`

##### Returns [#returns-41]

`void`

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-128]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`percentageY`](/pixi-vn/index/classes/ImageSprite#percentagey)

***

### pivot [#pivot]

#### Get Signature [#get-signature-21]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-74]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-42]

`ObservablePoint`

#### Set Signature [#set-signature-15]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-17]

###### value [#value-13]

`number` | `PointData`

##### Returns [#returns-43]

`void`

#### Inherited from [#inherited-from-129]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`pivot`](/pixi-vn/index/classes/ImageSprite#pivot)

***

### position [#position]

#### Get Signature [#get-signature-22]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/canvas/components/Sprite.ts:301](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L301)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-75]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-44]

`ObservablePoint`

#### Set Signature [#set-signature-16]

\> **set** **position**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L304)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-18]

###### value [#value-14]

`ObservablePoint`

##### Returns [#returns-45]

`void`

#### Inherited from [#inherited-from-130]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`position`](/pixi-vn/index/classes/ImageSprite#position)

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-23]

\> **get** **positionInfo**(): `object`

Defined in: [src/canvas/components/Sprite.ts:243](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L243)

##### Returns [#returns-46]

`object`

###### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-17]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:253](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L253)

##### Parameters [#parameters-19]

###### value [#value-15]

###### type? [#type-1]

`"pixel"` | `"percentage"` | `"align"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-47]

`void`

#### Inherited from [#inherited-from-131]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`positionInfo`](/pixi-vn/index/classes/ImageSprite#positioninfo)

***

### positionType [#positiontype]

#### Get Signature [#get-signature-24]

\> **get** **positionType**(): `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/Sprite.ts:235](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L235)

##### Returns [#returns-48]

`"pixel"` | `"percentage"` | `"align"`

#### Inherited from [#inherited-from-132]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`positionType`](/pixi-vn/index/classes/ImageSprite#positiontype)

***

### renderable [#renderable]

#### Get Signature [#get-signature-25]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-77]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* [Container#visible](#visible) For skipping transform updates
* [Container#alpha](#alpha) For transparency

##### Returns [#returns-49]

`boolean`

#### Set Signature [#set-signature-18]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-20]

###### value [#value-16]

`boolean`

##### Returns [#returns-50]

`void`

#### Inherited from [#inherited-from-133]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`renderable`](/pixi-vn/index/classes/ImageSprite#renderable)

***

### rotation [#rotation]

#### Get Signature [#get-signature-26]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-78]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-51]

`number`

#### Set Signature [#set-signature-19]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-21]

###### value [#value-17]

`number`

##### Returns [#returns-52]

`void`

#### Inherited from [#inherited-from-134]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`rotation`](/pixi-vn/index/classes/ImageSprite#rotation)

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-27]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-79]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-53]

`boolean`

#### Set Signature [#set-signature-20]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-22]

###### value [#value-18]

`boolean`

##### Returns [#returns-54]

`void`

#### Inherited from [#inherited-from-135]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`roundPixels`](/pixi-vn/index/classes/ImageSprite#roundpixels)

***

### scale [#scale]

#### Get Signature [#get-signature-28]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-80]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-55]

`ObservablePoint`

#### Set Signature [#set-signature-21]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-23]

###### value [#value-19]

`string` | `number` | `PointData`

##### Returns [#returns-56]

`void`

#### Inherited from [#inherited-from-136]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`scale`](/pixi-vn/index/classes/ImageSprite#scale)

***

### skew [#skew]

#### Get Signature [#get-signature-29]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-81]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-57]

`ObservablePoint`

#### Set Signature [#set-signature-22]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-24]

###### value [#value-20]

`PointData`

##### Returns [#returns-58]

`void`

#### Inherited from [#inherited-from-137]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`skew`](/pixi-vn/index/classes/ImageSprite#skew)

***

### texture [#texture]

#### Get Signature [#get-signature-30]

\> **get** **texture**(): `Texture`\<`TextureSource`\<`any`>>

Defined in: [src/canvas/components/ImageSprite.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L130)

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-82]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-20]

* [Texture](/pixi-vn/index/variables/Texture) For texture creation and management
* [Assets](/pixi-vn/index/variables/Assets) For asset loading

##### Returns [#returns-59]

`Texture`\<`TextureSource`\<`any`>>

#### Set Signature [#set-signature-23]

\> **set** **texture**(`value`): `void`

Defined in: [src/canvas/components/ImageSprite.ts:126](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L126)

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-83]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-21]

* [Texture](/pixi-vn/index/variables/Texture) For texture creation and management
* [Assets](/pixi-vn/index/variables/Assets) For asset loading

##### Parameters [#parameters-25]

###### value [#value-21]

`Texture`\<`TextureSource`\<`any`>>

##### Returns [#returns-60]

`void`

#### Inherited from [#inherited-from-138]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`texture`](/pixi-vn/index/classes/ImageSprite#texture)

***

### textureAlias [#texturealias-1]

#### Get Signature [#get-signature-31]

\> **get** `protected` **textureAlias**(): `string`

Defined in: [src/canvas/components/ImageSprite.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ImageSprite.ts#L44)

##### Returns [#returns-61]

`string`

#### Inherited from [#inherited-from-139]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`textureAlias`](/pixi-vn/index/classes/ImageSprite#texturealias)

***

### tint [#tint]

#### Get Signature [#get-signature-32]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-84]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-22]

* [Container#alpha](#alpha) For transparency
* [Container#visible](#visible) For visibility control

##### Returns [#returns-62]

`number`

#### Set Signature [#set-signature-24]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-26]

###### value [#value-22]

`ColorSource`

##### Returns [#returns-63]

`void`

#### Inherited from [#inherited-from-140]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`tint`](/pixi-vn/index/classes/ImageSprite#tint)

***

### visible [#visible]

#### Get Signature [#get-signature-33]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-85]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-23]

* [Container#renderable](#renderable) For render-only control
* [Container#alpha](#alpha) For transparency

##### Returns [#returns-64]

`boolean`

#### Set Signature [#set-signature-25]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-27]

###### value [#value-23]

`boolean`

##### Returns [#returns-65]

`void`

#### Inherited from [#inherited-from-141]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`visible`](/pixi-vn/index/classes/ImageSprite#visible)

***

### visualBounds [#visualbounds]

#### Get Signature [#get-signature-34]

\> **get** **visualBounds**(): `BoundsData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:205

The bounds of the sprite, taking into account the texture's trim area.

##### Example [#example-86]

````ts
const texture = new Texture({
    source: new TextureSource({ width: 300, height: 300 }),
    frame: new Rectangle(196, 66, 58, 56),
    trim: new Rectangle(4, 4, 58, 56),
    orig: new Rectangle(0, 0, 64, 64),
    rotate: 2,
});
const sprite = new Sprite(texture);
const visualBounds = sprite.visualBounds;
// console.log(visualBounds); // { minX: -4, maxX: 62, minY: -4, maxY: 60 }

##### Returns

`BoundsData`

#### Inherited from

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`visualBounds`](/pixi-vn/index/classes/ImageSprite#visualbounds)

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: node\_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:278

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example

```ts
// Set width directly
sprite.width = 200;
console.log(sprite.scale.x); // Scale adjusted to match width

// Set width while preserving aspect ratio
const ratio = sprite.height / sprite.width;
sprite.width = 300;
sprite.height = 300 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.width = sprite.texture.orig.width;
````

##### Returns [#returns-66]

`number`

#### Set Signature [#set-signature-26]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:279

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-28]

###### value [#value-24]

`number`

##### Returns [#returns-67]

`void`

#### Inherited from [#inherited-from-142]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`width`](/pixi-vn/index/classes/ImageSprite#width)

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-35]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-24]

[Container#localTransform](#localtransform) For local space transform

##### Returns [#returns-68]

`Matrix`

#### Inherited from [#inherited-from-143]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`worldTransform`](/pixi-vn/index/classes/ImageSprite#worldtransform)

***

### x [#x-2]

#### Get Signature [#get-signature-36]

> **get** **x**(): `number`

Defined in: [src/canvas/components/Sprite.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L309)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-69]

`number`

#### Set Signature [#set-signature-27]

> **set** **x**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:312](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L312)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-29]

###### value [#value-25]

`number`

##### Returns [#returns-70]

`void`

#### Inherited from [#inherited-from-144]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`x`](/pixi-vn/index/classes/ImageSprite#x)

***

### xAlign [#xalign]

#### Get Signature [#get-signature-37]

> **get** **xAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:168](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L168)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-71]

`number`

#### Set Signature [#set-signature-28]

> **set** **xAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:162](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L162)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-30]

###### value [#value-26]

`number`

##### Returns [#returns-72]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-145]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`xAlign`](/pixi-vn/index/classes/ImageSprite#xalign)

***

### y [#y-2]

#### Get Signature [#get-signature-38]

> **get** **y**(): `number`

Defined in: [src/canvas/components/Sprite.ts:317](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L317)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-73]

`number`

#### Set Signature [#set-signature-29]

> **set** **y**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:320](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L320)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-31]

###### value [#value-27]

`number`

##### Returns [#returns-74]

`void`

#### Inherited from [#inherited-from-146]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`y`](/pixi-vn/index/classes/ImageSprite#y)

***

### yAlign [#yalign]

#### Get Signature [#get-signature-39]

> **get** **yAlign**(): `number`

Defined in: [src/canvas/components/Sprite.ts:186](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L186)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-75]

`number`

#### Set Signature [#set-signature-30]

> **set** **yAlign**(`value`): `void`

Defined in: [src/canvas/components/Sprite.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L180)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-32]

###### value [#value-28]

`number`

##### Returns [#returns-76]

`void`

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-147]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`yAlign`](/pixi-vn/index/classes/ImageSprite#yalign)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-33]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-77]

`void`

#### Inherited from [#inherited-from-148]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_getGlobalBoundsRecursive`](/pixi-vn/index/classes/ImageSprite#_getglobalboundsrecursive)

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-34]

##### now [#now]

`number`

#### Returns [#returns-78]

`void`

#### Inherited from [#inherited-from-149]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`_onTouch`](/pixi-vn/index/classes/ImageSprite#_ontouch)

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-35]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-79]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-25]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

#### Inherited from [#inherited-from-150]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`addChild`](/pixi-vn/index/classes/ImageSprite#addchild)

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-1]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-36]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-80]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-26]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

#### Inherited from [#inherited-from-151]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`addChildAt`](/pixi-vn/index/classes/ImageSprite#addchildat)

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-2]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-37]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-81]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-152]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`addEventListener`](/pixi-vn/index/classes/ImageSprite#addeventlistener)

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-38]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-82]

`void`

##### Inherited from [#inherited-from-153]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`addEventListener`](/pixi-vn/index/classes/ImageSprite#addeventlistener)

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-3]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-39]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-83]

`this`

#### Inherited from [#inherited-from-154]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`addListener`](/pixi-vn/index/classes/ImageSprite#addlistener)

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-40]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-84]

`void`

#### Inherited from [#inherited-from-155]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`collectRenderables`](/pixi-vn/index/classes/ImageSprite#collectrenderables)

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-41]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-85]

`void`

#### Inherited from [#inherited-from-156]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`collectRenderablesSimple`](/pixi-vn/index/classes/ImageSprite#collectrenderablessimple)

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-42]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-86]

`void`

#### Inherited from [#inherited-from-157]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`collectRenderablesWithEffects`](/pixi-vn/index/classes/ImageSprite#collectrenderableswitheffects)

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-43]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-87]

`boolean`

True if the point is within the view's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-27]

* [ViewContainer#bounds](#bounds) For the bounds used in hit testing
* [Container#toLocal](#tolocal) For converting global coordinates to local

#### Inherited from [#inherited-from-158]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`containsPoint`](/pixi-vn/index/classes/ImageSprite#containspoint)

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-44]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-88]

`void`

#### Example [#example-97]

```ts
sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });
```

#### Inherited from [#inherited-from-159]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`destroy`](/pixi-vn/index/classes/ImageSprite#destroy)

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-89]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-160]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`disableRenderGroup`](/pixi-vn/index/classes/ImageSprite#disablerendergroup)

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-45]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-90]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-98]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-161]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`dispatchEvent`](/pixi-vn/index/classes/ImageSprite#dispatchevent)

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-46]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-91]

`boolean`

#### Inherited from [#inherited-from-162]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`emit`](/pixi-vn/index/classes/ImageSprite#emit)

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-92]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-163]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`enableRenderGroup`](/pixi-vn/index/classes/ImageSprite#enablerendergroup)

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-93]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-164]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`eventNames`](/pixi-vn/index/classes/ImageSprite#eventnames)

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-47]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-94]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-99]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-28]

* [Container#getLocalBounds](#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-165]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getBounds`](/pixi-vn/index/classes/ImageSprite#getbounds)

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-5]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-48]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-95]

`U`

The child at the given index

#### Example [#example-100]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-29]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

#### Inherited from [#inherited-from-166]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getChildAt`](/pixi-vn/index/classes/ImageSprite#getchildat)

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-49]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-96]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-101]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-30]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-167]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getChildByLabel`](/pixi-vn/index/classes/ImageSprite#getchildbylabel)

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-50]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-97]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-31]

Container#getChildByLabel

#### Inherited from [#inherited-from-168]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getChildByName`](/pixi-vn/index/classes/ImageSprite#getchildbyname)

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-51]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-98]

`number`

The index position of the child container

#### Example [#example-102]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-32]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

#### Inherited from [#inherited-from-169]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getChildIndex`](/pixi-vn/index/classes/ImageSprite#getchildindex)

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-52]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-99]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-103]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-33]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-170]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getChildrenByLabel`](/pixi-vn/index/classes/ImageSprite#getchildrenbylabel)

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-53]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-100]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-171]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getFastGlobalBounds`](/pixi-vn/index/classes/ImageSprite#getfastglobalbounds)

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-54]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-101]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-172]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getGlobalAlpha`](/pixi-vn/index/classes/ImageSprite#getglobalalpha)

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-55]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-102]

`Point`

The updated point

#### Example [#example-105]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-34]

* [Container#toGlobal](#toglobal) For converting specific points
* [Container#toLocal](#tolocal) For converting to local space

#### Inherited from [#inherited-from-173]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getGlobalPosition`](/pixi-vn/index/classes/ImageSprite#getglobalposition)

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-56]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-103]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-174]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getGlobalTint`](/pixi-vn/index/classes/ImageSprite#getglobaltint)

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-57]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-104]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-175]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getGlobalTransform`](/pixi-vn/index/classes/ImageSprite#getglobaltransform)

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-105]

`Bounds`

The bounding area

#### Example [#example-108]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-35]

* [Container#getBounds](#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-176]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getLocalBounds`](/pixi-vn/index/classes/ImageSprite#getlocalbounds)

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:322

Retrieves the size of the Sprite as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-58]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-106]

`Size`

The size of the Sprite

#### Example [#example-109]

```ts
// Basic size retrieval
const sprite = new Sprite(Texture.from('sprite.png'));
const size = sprite.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
sprite.getSize(reuseSize);
```

#### See [#see-36]

* [Sprite#width](/pixi-vn/index/classes/Sprite#width) For getting just the width
* [Sprite#height](/pixi-vn/index/classes/Sprite#height) For getting just the height
* [Sprite#setSize](/pixi-vn/index/classes/Sprite#setsize) For setting both width and height

#### Inherited from [#inherited-from-177]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`getSize`](/pixi-vn/index/classes/ImageSprite#getsize)

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-59]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-107]

`number`

#### Inherited from [#inherited-from-178]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`listenerCount`](/pixi-vn/index/classes/ImageSprite#listenercount)

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-60]

##### event [#event-3]

`T`

#### Returns [#returns-108]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-179]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`listeners`](/pixi-vn/index/classes/ImageSprite#listeners)

***

### load() [#load]

> **load**(): `Promise`\<`void`>

Defined in: [src/canvas/components/VideoSprite.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L76)

Load the image from the link and set the texture of the sprite.

#### Returns [#returns-109]

`Promise`\<`void`>

A promise that resolves when the image is loaded.

#### Overrides [#overrides-3]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`load`](/pixi-vn/index/classes/ImageSprite#load)

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-7]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-61]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-110]

`this`

#### Inherited from [#inherited-from-180]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`off`](/pixi-vn/index/classes/ImageSprite#off)

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/canvas/components/Sprite.ts:100](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L100)

Add a listener for a given event.

#### Type Parameters [#type-parameters-8]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-62]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-111]

`this`

#### Inherited from [#inherited-from-181]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`on`](/pixi-vn/index/classes/ImageSprite#on)

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-63]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-112]

`this`

#### Inherited from [#inherited-from-182]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`once`](/pixi-vn/index/classes/ImageSprite#once)

***

### pause() [#pause]

> **pause**(): `void`

Defined in: [src/canvas/components/VideoSprite.ts:114](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L114)

Pause the video.

#### Returns [#returns-113]

`void`

***

### play() [#play]

> **play**(): `void`

Defined in: [src/canvas/components/VideoSprite.ts:123](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L123)

Play the video.

#### Returns [#returns-114]

`void`

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: [src/canvas/components/Sprite.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Sprite.ts#L262)

#### Returns [#returns-115]

`void`

#### Inherited from [#inherited-from-183]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`reloadPosition`](/pixi-vn/index/classes/ImageSprite#reloadposition)

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-64]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-116]

`this`

#### Inherited from [#inherited-from-184]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeAllListeners`](/pixi-vn/index/classes/ImageSprite#removealllisteners)

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-10]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-65]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-117]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-37]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-185]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeChild`](/pixi-vn/index/classes/ImageSprite#removechild)

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-11]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-66]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-118]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-38]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-186]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeChildAt`](/pixi-vn/index/classes/ImageSprite#removechildat)

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-67]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-119]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-39]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

#### Inherited from [#inherited-from-187]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeChildren`](/pixi-vn/index/classes/ImageSprite#removechildren)

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-12]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-68]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-120]

`void`

##### Inherited from [#inherited-from-188]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeEventListener`](/pixi-vn/index/classes/ImageSprite#removeeventlistener)

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-69]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-121]

`void`

##### Inherited from [#inherited-from-189]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeEventListener`](/pixi-vn/index/classes/ImageSprite#removeeventlistener)

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-122]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-40]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

#### Inherited from [#inherited-from-190]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeFromParent`](/pixi-vn/index/classes/ImageSprite#removefromparent)

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-13]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-70]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-123]

`this`

#### Inherited from [#inherited-from-191]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`removeListener`](/pixi-vn/index/classes/ImageSprite#removelistener)

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-14]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-71]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-124]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-41]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

#### Inherited from [#inherited-from-192]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`reparentChild`](/pixi-vn/index/classes/ImageSprite#reparentchild)

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-72]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-125]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-42]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

#### Inherited from [#inherited-from-193]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`reparentChildAt`](/pixi-vn/index/classes/ImageSprite#reparentchildat)

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-16]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-73]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-126]

`void`

#### Inherited from [#inherited-from-194]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`replaceChild`](/pixi-vn/index/classes/ImageSprite#replacechild)

***

### restart() [#restart]

> **restart**(): `void`

Defined in: [src/canvas/components/VideoSprite.ts:154](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L154)

Restart the video.

#### Returns [#returns-127]

`void`

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-74]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-128]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-43]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

#### Inherited from [#inherited-from-195]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`setChildIndex`](/pixi-vn/index/classes/ImageSprite#setchildindex)

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-75]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-129]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-44]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-196]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`setFromMatrix`](/pixi-vn/index/classes/ImageSprite#setfrommatrix)

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-76]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-130]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-45]

* [Container#mask](#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-197]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`setMask`](/pixi-vn/index/classes/ImageSprite#setmask)

***

### setMemory() [#setmemory]

> **setMemory**(`value`): `Promise`\<`void`>

Defined in: [src/canvas/components/VideoSprite.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L65)

This method set the memory of the canvas element.

#### Parameters [#parameters-77]

##### value [#value-29]

[`VideoSpriteMemory`](/pixi-vn/index/interfaces/VideoSpriteMemory)

#### Returns [#returns-131]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Overrides [#overrides-4]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`setMemory`](/pixi-vn/index/classes/ImageSprite#setmemory)

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:353

Sets the size of the Sprite to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-78]

##### value [#value-30]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-132]

`void`

#### Example [#example-119]

```ts
// Basic size setting
const sprite = new Sprite(Texture.from('sprite.png'));
sprite.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
sprite.setSize(100); // Sets both width and height to 100

// Set size with object
sprite.setSize({
    width: 200,
    height: 300
});

// Reset to texture size
sprite.setSize(
    sprite.texture.orig.width,
    sprite.texture.orig.height
);
```

#### See [#see-46]

* [Sprite#width](/pixi-vn/index/classes/Sprite#width) For setting width only
* [Sprite#height](/pixi-vn/index/classes/Sprite#height) For setting height only
* [Sprite#texture](/pixi-vn/index/classes/Sprite#texture) For the source dimensions

#### Inherited from [#inherited-from-198]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`setSize`](/pixi-vn/index/classes/ImageSprite#setsize)

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-17]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-79]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-133]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-47]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

#### Inherited from [#inherited-from-199]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`swapChildren`](/pixi-vn/index/classes/ImageSprite#swapchildren)

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-18]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-80]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-134]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-48]

* [Container#toLocal](#tolocal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-200]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`toGlobal`](/pixi-vn/index/classes/ImageSprite#toglobal)

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-19]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-81]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-135]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-49]

* [Container#toGlobal](#toglobal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-201]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`toLocal`](/pixi-vn/index/classes/ImageSprite#tolocal)

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-136]

`void`

#### Inherited from [#inherited-from-202]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`unload`](/pixi-vn/index/classes/ImageSprite#unload)

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-137]

`void`

#### Inherited from [#inherited-from-203]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`updateLocalTransform`](/pixi-vn/index/classes/ImageSprite#updatelocaltransform)

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-82]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-138]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-50]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](/pixi-vn/index/interfaces/CanvasBaseInterface#position) For direct position access

#### Inherited from [#inherited-from-204]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`updateTransform`](/pixi-vn/index/classes/ImageSprite#updatetransform)

***

### from() [#from-1]

> `static` **from**(`source`, `skipCache?`): `VideoSprite`

Defined in: [src/canvas/components/VideoSprite.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/VideoSprite.ts#L69)

Creates a new sprite based on a source texture, image, video, or canvas element.
This is a convenience method that automatically creates and manages textures.

#### Parameters [#parameters-83]

##### source [#source]

`Texture`\<`TextureSource`\<`any`>> | [`TextureSourceLike`](/pixi-vn/index/type-aliases/TextureSourceLike)

The source to create the sprite from. Can be a path to an image, a texture,
or any valid texture source (canvas, video, etc.)

##### skipCache? [#skipcache]

`boolean`

Whether to skip adding to the texture cache when creating a new texture

#### Returns [#returns-139]

`VideoSprite`

A new sprite based on the source

#### Example [#example-124]

```ts
// Create from path or URL
const sprite = Sprite.from('assets/image.png');

// Create from existing texture
const sprite = Sprite.from(texture);

// Create from canvas
const canvas = document.createElement('canvas');
const sprite = Sprite.from(canvas, true); // Skip caching new texture
```

#### See [#see-51]

* Texture.from For texture creation details
* [Assets](/pixi-vn/index/variables/Assets) For asset loading and management

#### Overrides [#overrides-5]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`from`](/pixi-vn/index/classes/ImageSprite#from)

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-84]

##### source [#source-1]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-140]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

#### Inherited from [#inherited-from-205]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite).[`mixin`](/pixi-vn/index/classes/ImageSprite#mixin)


# Function: addImage() (/pixi-vn/index/functions/addImage)



\> **addImage**(`alias`, `imageUrl?`, `options?`): [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)

Defined in: [src/canvas/functions/image-utility.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/image-utility.ts#L25)

Add a image in the canvas.
Is the same that [showImage](/pixi-vn/index/functions/showImage), but the image is not shown.
If you want to show the image, then you need to use the function [ImageSprite.load](/pixi-vn/index/classes/ImageSprite#load).

## Parameters [#parameters]

### alias [#alias]

`string`

is the unique alias of the image. You can use this alias to refer to this image

### imageUrl? [#imageurl]

`string`

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.

### options? [#options]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions)

The options of the image.

## Returns [#returns]

[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)

This function returns an [ImageSprite](/pixi-vn/index/classes/ImageSprite) that you can use to manipulate the component.

## Throws [#throws]

when `imageUrl` is not provided and `alias` is not registered in the asset cache.

## Example [#example]

```ts
let bunny1 = addImage("bunny1", "https://pixijs.com/assets/bunny1.png")
await bunny1.load()
Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
let bunny2 = addImage("bunny2")
await bunny2.load()
```


# Function: addImageCointainer() (/pixi-vn/index/functions/addImageCointainer)



\> **addImageCointainer**(`alias`, `imageUrls`, `options?`): [`ImageContainer`](/pixi-vn/index/classes/ImageContainer)

Defined in: [src/canvas/functions/image-container-utility.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/image-container-utility.ts#L19)

Add a list of images in the container, after that, the images are added to the canvas.
Is the same that [showImageContainer](/pixi-vn/index/functions/showImageContainer), but the image is not shown.
If you want to show the container, then you need to use the function [()](/pixi-vn/index/classes/ImageSprite#load).

## Parameters [#parameters]

### alias [#alias]

`string`

is the unique alias of the container. You can use this alias to refer to this container

### imageUrls [#imageurls]

`string`\[]

is the url of the image. If you don't provide the url, then the alias is used as the url.

### options? [#options]

[`ImageContainerOptions`](/pixi-vn/index/interfaces/ImageContainerOptions)\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>>

The options of the container.

## Returns [#returns]

[`ImageContainer`](/pixi-vn/index/classes/ImageContainer)

This function returns an [ImageContainer](/pixi-vn/index/classes/ImageContainer) that you can use to manipulate the component.

## Example [#example]

```ts
let bunny = addImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
await bunny.load()
```


# Function: addListenerHandler() (/pixi-vn/index/functions/addListenerHandler)



\> **addListenerHandler**\<`T`>(`event`, `element`, `fn`): `boolean`

Defined in: [src/canvas/components/ListenerExtension.ts:52](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L52)

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* [`ListenerExtension`](/pixi-vn/index/interfaces/ListenerExtension)

## Parameters [#parameters]

### event [#event]

`string` | `symbol`

### element [#element]

`T`

### fn [#fn]

(...`args`) => `unknown`

## Returns [#returns]

`boolean`


# Function: addVideo() (/pixi-vn/index/functions/addVideo)



\> **addVideo**(`alias`, `videoUrl?`, `options?`): [`VideoSprite`](/pixi-vn/index/classes/VideoSprite)

Defined in: [src/canvas/functions/video-utility.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/video-utility.ts#L25)

Add a video in the canvas.
Is the same that [showVideo](/pixi-vn/index/functions/showVideo), but the video is not shown.
If you want to show the video, then you need to use the function [()](/pixi-vn/index/classes/VideoSprite#load).

## Parameters [#parameters]

### alias [#alias]

`string`

is the unique alias of the video. You can use this alias to refer to this video

### videoUrl? [#videourl]

`string`

is the url of the video. If you don't provide the url, then the alias is used as the url.

### options? [#options]

[`VideoSpriteOptions`](/pixi-vn/index/interfaces/VideoSpriteOptions)

The options of the video.

## Returns [#returns]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite)

This function returns an [VideoSprite](/pixi-vn/index/classes/VideoSprite) that you can use to manipulate the component.

## Throws [#throws]

when `videoUrl` is not provided and `alias` is not registered in the asset cache.

## Example [#example]

```ts
let video1 = addVideo("video1", "https://pixijs.com/assets/video1.mp4")
await video1.load()
Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
let video2 = addVideo("video2")
await video2.load()
```


# Function: analizePositionsExtensionProps() (/pixi-vn/index/functions/analizePositionsExtensionProps)



\> **analizePositionsExtensionProps**\<`T`>(`props?`): `T` | `undefined`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:131](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L131)

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* [`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Parameters [#parameters]

### props? [#props]

`T`

## Returns [#returns]

`T` | `undefined`


# Function: canvasComponentDecorator() (/pixi-vn/index/functions/canvasComponentDecorator)



\> **canvasComponentDecorator**\<`M`, `T`>(`options?`): (`target`) => `void`

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L51)

Is a decorator that register a canvas component in the game.

## Type Parameters [#type-parameters]

### M [#m]

`M` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

### T [#t]

`T` *extends* *typeof* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)

## Parameters [#parameters]

### options? [#options]

Options for the canvas component.

#### copyProperty? [#copyproperty]

(`component`, `memory`) => `void` | `Promise`\<`void`>

Function to copy the properties of the canvas component. This function is used when to copy the properties of the canvas component into another instance of the same canvas component.
This function is used into [canvas.copyCanvasElementProperty](/pixi-vn/index/interfaces/CanvasManagerInterface#copycanvaselementproperty) to copy the properties of the canvas component.

#### getInstance? [#getinstance]

(`canvasClass`, `memory`) => [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`> | `Promise`\<[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`>>

Function to get the instance of the canvas component. If not set, it will use the default constructor of the class.
This function is used into [canvas.restore](/pixi-vn/index/interfaces/CanvasManagerInterface#restore) to restore the canvas.

#### name? [#name]

`string`

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**

```ts
target.name
```

## Returns [#returns]

(`target`) => `void`

## Example [#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) {
        // ...
    }
    // ...
}
```


# Function: cloneMaybeOffloaded() (/pixi-vn/index/functions/cloneMaybeOffloaded)



\> **cloneMaybeOffloaded**\<`T`>(`value`): `Promise`\<`T`>

Defined in: [src/worker/offload.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/offload.ts#L47)

Deep-clones `value` (matching `createExportableElement`'s JSON-round-trip semantics), via the
registered game worker if available, falling back to the main thread otherwise.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object`

## Parameters [#parameters]

### value [#value]

`T`

## Returns [#returns]

`Promise`\<`T`>


# Function: createExportableElement() (/pixi-vn/index/functions/createExportableElement)



\> **createExportableElement**\<`T`>(`element`): `T`

Defined in: [src/utils/export-utility.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/utils/export-utility.ts#L10)

This function is used to create a deep copy of the element

## Type Parameters [#type-parameters]

### T [#t]

`T`

## Parameters [#parameters]

### element [#element]

`T`

The element to be copied

## Returns [#returns]

`T`

The copied element

## Throws [#throws]

when the element is not JSON serializable (e.g. contains functions or class instances).


# Function: diffMaybeOffloaded() (/pixi-vn/index/functions/diffMaybeOffloaded)



\> **diffMaybeOffloaded**(`before`, `after`): `Promise`\<`Difference`\[]>

Defined in: [src/worker/offload.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/offload.ts#L32)

Computes the difference between `before` and `after`, via the registered game worker if
available, falling back to the main thread otherwise. Mirrors
[restoreDiffMaybeOffloaded](/pixi-vn/index/functions/restoreDiffMaybeOffloaded) - same worker, opposite direction.

## Parameters [#parameters]

### before [#before]

`object`

### after [#after]

`object`

## Returns [#returns]

`Promise`\<`Difference`\[]>


# Function: drainCompleteOnStepEndQueue() (/pixi-vn/index/functions/drainCompleteOnStepEndQueue)



\> **drainCompleteOnStepEndQueue**(): `object`

Defined in: [src/tickers/index.ts:538](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/index.ts#L538)

Drains the `completeOnStepEnd` queue, returning what was in it. Used by `canvas/index.ts`'s
pre-continue handler, which used to reach into `CanvasManagerStatic._tickersToCompleteOnStepEnd`
directly - draining through this function keeps that state fully encapsulated in this module.

## Returns [#returns]

`object`

### stepAlias [#stepalias]

\> **stepAlias**: `object`\[]

### tikersIds [#tikersids]

\> **tikersIds**: `object`\[]


# Function: drawCanvasErrorHandler() (/pixi-vn/index/functions/drawCanvasErrorHandler)



\> **drawCanvasErrorHandler**(): [`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)

Defined in: [src/canvas/functions/error-handler.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/error-handler.ts#L12)

Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
draw a simple `ErrorGraphics` placeholder on the canvas so the scene
remains visible and debuggable.

## Returns [#returns]

[`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)


# Function: eventDecorator() (/pixi-vn/index/functions/eventDecorator)



\> **eventDecorator**(`name?`): (`_target`, `propertyKey`, `descriptor`) => `void`

Defined in: [src/canvas/decorators/event-decorator.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L29)

Is a decorator that register a event in the game.
Is a required decorator for use the event in the game.
Thanks to this decoration the game has the possibility of updating the events to the latest modification and saving the game.

## Parameters [#parameters]

### name? [#name]

`string`

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 [#returns]

(`_target`, `propertyKey`, `descriptor`) => `void`

## Example [#example]

```ts
export class Events {
    \@eventDecorator()
    static eventExample(event: FederatedEvent, component: Sprite) {
        // event code here
    }
}

sprite.on("pointerdown", Events.eventExample);
```


# Function: getTexture() (/pixi-vn/index/functions/getTexture)



\> **getTexture**(`textureAlias?`): `Promise`\<`Texture`\<`TextureSource`\<`any`>> | `undefined`>

Defined in: [src/canvas/functions/texture-utility.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/texture-utility.ts#L12)

Get a texture from a url.

## Parameters [#parameters]

### textureAlias? [#texturealias]

`string`

is the url of the file.

## Returns [#returns]

`Promise`\<`Texture`\<`TextureSource`\<`any`>> | `undefined`>

the texture of the image or video, or `undefined` when `textureAlias` is the `"EMPTY"` sentinel value.

## Throws [#throws]

when the alias is missing, the asset is not found in the cache/network, or the loaded resource is not a `Texture`.


# Function: handleGameWorkerMessage() (/pixi-vn/index/functions/handleGameWorkerMessage)



\> **handleGameWorkerMessage**(`request`): `Promise`\<[`GameWorkerResponse`](/pixi-vn/index/type-aliases/GameWorkerResponse)>

Defined in: [src/worker/handleGameWorkerMessage.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/handleGameWorkerMessage.ts#L26)

The worker-side half of the [GameWorkerManager](/pixi-vn/index/classes/GameWorkerManager) protocol. The game project creates its
own Worker (so it controls the bundler-specific setup) and points its `message` handling here:

```ts
// game-worker.ts, built as its own entry by the project's bundler
import { handleGameWorkerMessage } from "@drincs/pixi-vn/worker";

self.onmessage = async (event) => {
    const response = await handleGameWorkerMessage(event.data);
    if (response) self.postMessage(response);
};
```

A third-party library sharing this same worker (see `registerGameWorkerHandler`) just needs
its own worker-side registration module imported alongside this one, in that same file.

Everything this processes is plain, structured-clone-safe data by construction - it never
touches PixiJS/canvas/audio, which only exist on the main thread.

## Parameters [#parameters]

### request [#request]

[`GameWorkerRequest`](/pixi-vn/index/type-aliases/GameWorkerRequest)

## Returns [#returns]

`Promise`\<[`GameWorkerResponse`](/pixi-vn/index/type-aliases/GameWorkerResponse)>


# Function: moveIn() (deprecated) (/pixi-vn/index/functions/moveIn)



\> **moveIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:131](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L131)

## Parameters [#parameters]

### alias [#alias]

`string`

### component? [#component]

`TComponent`

### props? [#props]

[`MoveInOutProps`](/pixi-vn/index/interfaces/MoveInOutProps) & `object` = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `transitions.moveIn` instead.


# Function: moveOut() (deprecated) (/pixi-vn/index/functions/moveOut)



\> **moveOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:149](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L149)

## Parameters [#parameters]

### alias [#alias]

`string`

### props? [#props]

[`MoveInOutProps`](/pixi-vn/index/interfaces/MoveInOutProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`string`\[] | `undefined`

## Deprecated [#deprecated]

Use `transitions.moveOut` instead.


# Function: newChoiceOption() (/pixi-vn/index/functions/newChoiceOption)



\> **newChoiceOption**\<`T`>(`text`, `label`, `props`, `options?`): [`ChoiceOptionInterface`](/pixi-vn/index/interfaces/ChoiceOptionInterface)

Defined in: [src/narration/classes/ChoiceMenuOption.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/ChoiceMenuOption.ts#L29)

Function to create a new choice menu option.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* [`StorageObjectType`](/pixi-vn/index/type-aliases/StorageObjectType)

## Parameters [#parameters]

### text [#text]

`string` | `string`\[]

The text displayed in the choice menu.

### label [#label]

`string` | [`Label`](/pixi-vn/index/classes/Label)\<`T`> | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

The `label` to call when the player selects the option.

### props [#props]

`T`

The properties passed to the `label`. If the `label` does not require parameters, pass an empty object `{}`.

### options? [#options]

`ChoiceMenuOptionOptions`

An object with the `choice`'s options

## Returns [#returns]

[`ChoiceOptionInterface`](/pixi-vn/index/interfaces/ChoiceOptionInterface)

## Example [#example]

```ts
newChoiceOption("Hello", HelloLabel, {})
```


# Function: newCloseChoiceOption() (/pixi-vn/index/functions/newCloseChoiceOption)



\> **newCloseChoiceOption**(`text`, `options?`): [`CloseChoiceOptionInterface`](/pixi-vn/index/interfaces/CloseChoiceOptionInterface)

Defined in: [src/narration/classes/CloseChoiceOption.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/classes/CloseChoiceOption.ts#L24)

In addition to `newChoiceOption`, you can use `newCloseChoiceOption` to create a closing option.
This closes the choice menu and continues with the `steps`, without calling any `label`.

## Parameters [#parameters]

### text [#text]

`string` | `string`\[]

The text displayed in the choice menu.

### options? [#options]

`ChoiceMenuOptionCloseOptions`

An object with the `choice`'s options

## Returns [#returns]

[`CloseChoiceOptionInterface`](/pixi-vn/index/interfaces/CloseChoiceOptionInterface)

## Example [#example]

```ts
newCloseChoiceOption("Return")
```


# Function: newLabel() (/pixi-vn/index/functions/newLabel)



\> **newLabel**\<`T`>(`id`, `steps`, `props?`): [`Label`](/pixi-vn/index/classes/Label)\<`T`>

Defined in: [src/narration/decorators/newLabel.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/newLabel.ts#L14)

Creates a new label and registers it in the system.
**This function must be called at least once at system startup to register the label, otherwise the system cannot be used.**

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }

## Parameters [#parameters]

### id [#id]

`string`

A unique identifier. Used to reference the `label` in the game (must be unique).

### steps [#steps]

[`LabelSteps`](/pixi-vn/index/type-aliases/LabelSteps)\<`T`> | (() => [`LabelSteps`](/pixi-vn/index/type-aliases/LabelSteps)\<`T`>)

An array of functions to be executed in order. To create a dynamic array.

### props? [#props]

[`LabelProps`](/pixi-vn/index/interfaces/LabelProps)\<[`Label`](/pixi-vn/index/classes/Label)\<`T`>, `number`>

An object with the `label`'s options

## Returns [#returns]

[`Label`](/pixi-vn/index/classes/Label)\<`T`>

The created label


# Function: pushIn() (deprecated) (/pixi-vn/index/functions/pushIn)



\> **pushIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:189](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L189)

## Parameters [#parameters]

### alias [#alias]

`string`

### component? [#component]

`TComponent`

### props? [#props]

[`PushInOutProps`](/pixi-vn/index/interfaces/PushInOutProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `transitions.pushIn` instead.


# Function: pushOut() (deprecated) (/pixi-vn/index/functions/pushOut)



\> **pushOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:201](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L201)

## Parameters [#parameters]

### alias [#alias]

`string`

### props? [#props]

[`PushInOutProps`](/pixi-vn/index/interfaces/PushInOutProps) = `...`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`string`\[] | `undefined`

## Deprecated [#deprecated]

Use `transitions.pushOut` instead.


# Function: registerGameWorkerHandler() (/pixi-vn/index/functions/registerGameWorkerHandler)



\> **registerGameWorkerHandler**(`kind`, `handler`): `void`

Defined in: [src/worker/GameWorkerHandlerRegistry.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerHandlerRegistry.ts#L29)

Registers (or replaces) the worker-side handler for `kind`. See this file's doc comment.

## Parameters [#parameters]

### kind [#kind]

`string`

### handler [#handler]

[`GameWorkerHandler`](/pixi-vn/index/type-aliases/GameWorkerHandler)

## Returns [#returns]

`void`


# Function: removeTicker() (/pixi-vn/index/functions/removeTicker)



\> **removeTicker**(`tickerId`, `options?`): `void`

Defined in: [src/tickers/index.ts:321](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/index.ts#L321)

Removes one or more tickers by id, with an extra `stopTicker` option beyond what
[tickers](/pixi-vn/index/variables/tickers).remove exposes - kept as its own named export for `CanvasManager`'s deprecated
`removeTicker(tickerId, options)` flat method, which historically supported it.

## Parameters [#parameters]

### tickerId [#tickerid]

`string` | `string`\[]

### options? [#options]

#### stopTicker? [#stopticker]

`boolean`

## Returns [#returns]

`void`


# Function: removeWithDissolve() (deprecated) (/pixi-vn/index/functions/removeWithDissolve)



\> **removeWithDissolve**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:97](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L97)

## Parameters [#parameters]

### alias [#alias]

`string`

### props? [#props]

[`ShowWithDissolveTransitionProps`](/pixi-vn/index/interfaces/ShowWithDissolveTransitionProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`string`\[] | `undefined`

## Deprecated [#deprecated]

Use `transitions.removeWithDissolve` instead.


# Function: removeWithFade() (deprecated) (/pixi-vn/index/functions/removeWithFade)



\> **removeWithFade**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:120](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L120)

## Parameters [#parameters]

### alias [#alias]

`string`

### props? [#props]

[`ShowWithFadeTransitionProps`](/pixi-vn/index/interfaces/ShowWithFadeTransitionProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`string`\[] | `undefined`

## Deprecated [#deprecated]

Use `transitions.removeWithFade` instead.


# Function: restoreDiffMaybeOffloaded() (/pixi-vn/index/functions/restoreDiffMaybeOffloaded)



\> **restoreDiffMaybeOffloaded**\<`T`>(`state`, `stateDiff`): `Promise`\<`T`>

Defined in: [src/worker/offload.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/offload.ts#L13)

Applies `stateDiff` to `state`, via the registered game worker if one is available (see
`Game.worker`), falling back to computing it synchronously on the main thread otherwise -
whether that's because no worker was registered, or because the worker call itself failed (the
caller should never hard-fail just because the optional worker hiccuped).

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object`

## Parameters [#parameters]

### state [#state]

`T`

### stateDiff [#statediff]

`Difference`\[]

## Returns [#returns]

`Promise`\<`T`>


# Function: runTickersSequence() (/pixi-vn/index/functions/runTickersSequence)



\> **runTickersSequence**\<`TArgs`>(`alias`, `key`): `void`

Defined in: [src/tickers/index.ts:107](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/index.ts#L107)

Runs (or resumes) a single step of a ticker sequence. Exported (beyond the [tickers](/pixi-vn/index/variables/tickers) public
surface) because `CanvasManager.restore()` reconstructs sequences from serialized save data at a
lower level than addSequence operates at.

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

## Parameters [#parameters]

### alias [#alias]

`string`

### key [#key]

`string`

## Returns [#returns]

`void`


# Function: setMemoryContainer() (/pixi-vn/index/functions/setMemoryContainer)



\> **setMemoryContainer**\<`T`>(`element`, `memory`, `options?`): `Promise`\<`void`>

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:84](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L84)

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `Container`\<`ContainerChild`>

## Parameters [#parameters]

### element [#element]

`Container`\<`ContainerChild`> | `T`

### memory [#memory]

\{ } | `Partial`\<[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)\<[`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)>>

### options? [#options]

#### end? [#end]

() => `void` | `Promise`\<`void`>

#### ignoreScale? [#ignorescale]

`boolean`

## Returns [#returns]

`Promise`\<`void`>


# Function: shakeEffect() (deprecated) (/pixi-vn/index/functions/shakeEffect)



\> **shakeEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L29)

## Parameters [#parameters]

### alias [#alias]

`string`

### options? [#options]

[`ShakeEffectProps`](/pixi-vn/index/interfaces/ShakeEffectProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `effects.shakeEffect` instead.


# Function: showImage() (/pixi-vn/index/functions/showImage)



\> **showImage**(`alias`, `imageUrl?`, `options?`): `Promise`\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>>

Defined in: [src/canvas/functions/image-utility.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/image-utility.ts#L69)

Add and show a image in the canvas. This function is a combination of [addImage](/pixi-vn/index/functions/addImage).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### imageUrl? [#imageurl]

`string`

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.

### options? [#options]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions)

The options of the image.

## Returns [#returns]

`Promise`\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>>

This function returns an [ImageSprite](/pixi-vn/index/classes/ImageSprite) that you can use to manipulate the component.

## Throws [#throws]

when `imageUrl` is not provided and `alias` is not registered in the asset cache.

## Example [#example]

```ts
let bunny1 = showImage("bunny1", "https://pixijs.com/assets/bunny1.png")
Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
let bunny2 = showImage("bunny2")
```


# Function: showImageContainer() (/pixi-vn/index/functions/showImageContainer)



\> **showImageContainer**(`alias`, `imageUrls`, `options?`): `Promise`\<[`ImageContainer`](/pixi-vn/index/classes/ImageContainer)>

Defined in: [src/canvas/functions/image-container-utility.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/image-container-utility.ts#L44)

Add a list of images in the container, after that, the images are added and shown in the canvas.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the container. You can use this alias to refer to this container

### imageUrls [#imageurls]

`string`\[]

The url of the image.

### options? [#options]

[`ImageContainerOptions`](/pixi-vn/index/interfaces/ImageContainerOptions)\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>>

The options of the container.

## Returns [#returns]

`Promise`\<[`ImageContainer`](/pixi-vn/index/classes/ImageContainer)>

This function returns an [ImageContainer](/pixi-vn/index/classes/ImageContainer) that you can use to manipulate the component.

## Example [#example]

```ts
let bunny = showImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
```


# Function: showText() (/pixi-vn/index/functions/showText)



\> **showText**(`alias`, `text`, `options?`): [`Text`](/pixi-vn/index/classes/Text)

Defined in: [src/canvas/functions/text-utility.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/text-utility.ts#L14)

Add and show a text in the canvas.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the text. You can use this alias to refer to this text.

### text [#text]

`string`

### options? [#options]

`Omit`\<[`TextOptions`](/pixi-vn/index/interfaces/TextOptions), `"text"`>

The options of the text.

## Returns [#returns]

[`Text`](/pixi-vn/index/classes/Text)

This function returns an [Text](/pixi-vn/index/classes/Text) that you can use to manipulate the component.

## Example [#example]

```ts
let text = showText("text", "Hello World", { fontSize: 24, fill: "white" })
```


# Function: showVideo() (/pixi-vn/index/functions/showVideo)



\> **showVideo**(`alias`, `videoUrl?`, `options?`): `Promise`\<[`VideoSprite`](/pixi-vn/index/classes/VideoSprite)>

Defined in: [src/canvas/functions/video-utility.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/video-utility.ts#L69)

Add and show a video in the canvas. This function is a combination of [addVideo](/pixi-vn/index/functions/addVideo).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the video. You can use this alias to refer to this video

### videoUrl? [#videourl]

`string`

The url of the video.

### options? [#options]

[`VideoSpriteOptions`](/pixi-vn/index/interfaces/VideoSpriteOptions)

The options of the video.

## Returns [#returns]

`Promise`\<[`VideoSprite`](/pixi-vn/index/classes/VideoSprite)>

This function returns an [VideoSprite](/pixi-vn/index/classes/VideoSprite) that you can use to manipulate the component.

## Throws [#throws]

when `videoUrl` is not provided and `alias` is not registered in the asset cache.

## Example [#example]

```ts
let video1 = showVideo("video1", "https://pixijs.com/assets/video1.mp4")
Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
let video2 = showVideo("video2")
```


# Function: showWithDissolve() (deprecated) (/pixi-vn/index/functions/showWithDissolve)



\> **showWithDissolve**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:85](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L85)

## Parameters [#parameters]

### alias [#alias]

`string`

### component? [#component]

`TComponent`

### props? [#props]

[`ShowWithDissolveTransitionProps`](/pixi-vn/index/interfaces/ShowWithDissolveTransitionProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `transitions.showWithDissolve` instead.


# Function: showWithFade() (deprecated) (/pixi-vn/index/functions/showWithFade)



\> **showWithFade**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:108](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L108)

## Parameters [#parameters]

### alias [#alias]

`string`

### component? [#component]

`TComponent`

### props? [#props]

[`ShowWithFadeTransitionProps`](/pixi-vn/index/interfaces/ShowWithFadeTransitionProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `transitions.showWithFade` instead.


# Function: tickerDecorator() (/pixi-vn/index/functions/tickerDecorator)



\> **tickerDecorator**(`name?`): (`target`) => `void`

Defined in: [src/tickers/decorators/RegisteredTickers.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L32)

Is a decorator that register a ticker in the game.
Is a required decorator for use the ticker in the game.
Thanks to this decoration the game has the possibility of updating the tickers to the latest modification and saving the game.

## Parameters [#parameters]

### name? [#name]

`string`

is th identifier of the label, by default is the name of the class

## Returns [#returns]

(`target`) => `void`


# Function: unregisterGameWorkerHandler() (/pixi-vn/index/functions/unregisterGameWorkerHandler)



\> **unregisterGameWorkerHandler**(`kind`): `void`

Defined in: [src/worker/GameWorkerHandlerRegistry.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerHandlerRegistry.ts#L34)

Removes the worker-side handler previously registered for `kind`, if any.

## Parameters [#parameters]

### kind [#kind]

`string`

## Returns [#returns]

`void`


# Function: zoomIn() (deprecated) (/pixi-vn/index/functions/zoomIn)



\> **zoomIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:160](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L160)

## Parameters [#parameters]

### alias [#alias]

`string`

### component? [#component]

`TComponent`

### props? [#props]

[`ZoomInOutProps`](/pixi-vn/index/interfaces/ZoomInOutProps) & `object` = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

## Deprecated [#deprecated]

Use `transitions.zoomIn` instead.


# Function: zoomOut() (deprecated) (/pixi-vn/index/functions/zoomOut)



\> **zoomOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:178](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L178)

## Parameters [#parameters]

### alias [#alias]

`string`

### props? [#props]

[`ZoomInOutProps`](/pixi-vn/index/interfaces/ZoomInOutProps) = `{}`

### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

`string`\[] | `undefined`

## Deprecated [#deprecated]

Use `transitions.zoomOut` instead.


# index (/pixi-vn/index)



## app [#app]

* [ApplicationOptions](/pixi-vn/index/interfaces/ApplicationOptions)

## assets [#assets]

* [AssetsBundle](/pixi-vn/index/interfaces/AssetsBundle)
* [AssetsManifest](/pixi-vn/index/interfaces/AssetsManifest)
* [ResolvedAsset](/pixi-vn/index/interfaces/ResolvedAsset)
* [ResolvedSrc](/pixi-vn/index/interfaces/ResolvedSrc)
* [UnresolvedAsset](/pixi-vn/index/interfaces/UnresolvedAsset)
* [AssetSrc](/pixi-vn/index/type-aliases/AssetSrc)
* [~~LoadParserName~~](/pixi-vn/index/type-aliases/LoadParserName)

## events [#events]

* [FederatedEvent](/pixi-vn/index/interfaces/FederatedEvent)
* [AllFederatedEventMap](/pixi-vn/index/type-aliases/AllFederatedEventMap)

## Other [#other]

### TickersInterface [#tickersinterface]

Renames and re-exports [CanvasTickersInterface](/pixi-vn/index/interfaces/CanvasTickersInterface)

## rendering [#rendering]

* [TextureSourceLike](/pixi-vn/index/type-aliases/TextureSourceLike)

## ticker [#ticker]

* [TickerValue](/pixi-vn/index/interfaces/TickerValue)


# Interface: AdditionalPositionsExtension (/pixi-vn/index/interfaces/AdditionalPositionsExtension)



Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:66](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L66)

## Properties [#properties]

### align [#align]

\> **align**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L76)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

***

### percentagePosition [#percentageposition]

\> **percentagePosition**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:106](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L106)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### percentageX [#percentagex]

\> **percentageX**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:116](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L116)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### percentageY [#percentagey]

\> **percentageY**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:126](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L126)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### positionInfo [#positioninfo]

\> `readonly` **positionInfo**: `object`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L128)

#### type [#type]

\> **type**: `"pixel"` | `"percentage"` | `"align"`

#### x [#x]

\> **x**: `number`

#### y [#y]

\> **y**: `number`

***

### positionType [#positiontype]

\> `readonly` **positionType**: `"pixel"` | `"percentage"` | `"align"`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:127](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L127)

***

### xAlign [#xalign]

\> **xAlign**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L86)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

***

### yAlign [#yalign]

\> **yAlign**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:96](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L96)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.


# Interface: AdditionalPositionsExtensionProps (/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)



Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L3)

## Extended by [#extended-by]

* [`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions)
* [`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions)
* [`TextOptions`](/pixi-vn/index/interfaces/TextOptions)
* [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)
* [`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory)
* [`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

## Properties [#properties]

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

***

### percentagePosition? [#percentageposition]

\> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### percentageX? [#percentagex]

\> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### percentageY? [#percentagey]

\> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

***

### xAlign? [#xalign]

\> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

***

### yAlign? [#yalign]

\> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.


# Interface: AnchorExtension (/pixi-vn/index/interfaces/AnchorExtension)



Defined in: [src/canvas/components/AnchorExtension.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L7)

## Properties [#properties]

### anchor [#anchor]

\> **anchor**: `PointData`

Defined in: [src/canvas/components/AnchorExtension.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L25)

The anchor sets the origin point of the imageContainer. The default value is taken from the [Texture](/pixi-vn/index/variables/Texture)
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

#### Example [#example]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```


# Interface: AnchorExtensionProps (/pixi-vn/index/interfaces/AnchorExtensionProps)



Defined in: [src/canvas/components/AnchorExtension.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L3)

## Extended by [#extended-by]

* [`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions)

## Properties [#properties]

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: [src/canvas/components/AnchorExtension.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L4)


# Interface: ApplicationOptions (/pixi-vn/index/interfaces/ApplicationOptions)



Defined in: node_modules/pixi.js/lib/app/Application.d.ts:107

Application options supplied to the Application#init method.
These options configure how your PixiJS application behaves.

## Standard [#standard]

## Example [#example]

```js
import { Application } from 'pixi.js';

const app = new Application();

// Initialize with common options
await app.init({
   // Rendering options
   width: 800,                    // Canvas width
   height: 600,                   // Canvas height
   backgroundColor: 0x1099bb,     // Background color
   antialias: true,              // Enable antialiasing
   resolution: window.devicePixelRatio, // Screen resolution

   // Performance options
   autoStart: true,              // Auto-starts the render loop
   sharedTicker: true,           // Use shared ticker for better performance

   // Automatic resize options
   resizeTo: window,             // Auto-resize to window
   autoDensity: true,           // Adjust for device pixel ratio

   // Advanced options
   preference: 'webgl',         // Renderer preference ('webgl', 'webgpu', 'canvas', or an array)
   powerPreference: 'high-performance' // GPU power preference
});
```

## See [#see]

* WebGLOptions For resize-related options
* WebGPUOptions For resize-related options
* TickerPlugin For ticker-related options
* ResizePlugin For resize-related options

## Extends [#extends]

* `AutoDetectOptions`.`ApplicationOptions`

## Properties [#properties]

### antialias? [#antialias]

\> `optional` **antialias?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:43

Whether to enable anti-aliasing. This may affect performance.

#### Inherited from [#inherited-from]

`AutoDetectOptions.antialias`

***

### autoDensity? [#autodensity]

\> `optional` **autoDensity?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:39

Resizes renderer view in CSS pixels to allow for resolutions other than 1.

This is only supported for HTMLCanvasElement
and will be ignored if the canvas is an OffscreenCanvas.

#### Inherited from [#inherited-from-1]

`AutoDetectOptions.autoDensity`

***

### autoStart? [#autostart]

\> `optional` **autoStart?**: `boolean`

Defined in: node_modules/pixi.js/lib/app/TickerPlugin.d.ts:55

Controls whether the animation loop starts automatically after initialization.
\> \[!IMPORTANT]
\> Setting this to `false` does NOT stop the shared ticker even if `sharedTicker` is `true`.
\> You must stop the shared ticker manually if needed.

#### Example [#example-1]

```ts
// Auto-start (default behavior)
await app.init({ autoStart: true });

// Manual start
await app.init({ autoStart: false });
app.start(); // Start when ready
```

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-2]

`PixiMixins.ApplicationOptions.autoStart`

***

### background? [#background]

\> `optional` **background?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/background/BackgroundSystem.d.ts:17

Alias for `backgroundColor`

#### Inherited from [#inherited-from-3]

`AutoDetectOptions.background`

***

### backgroundAlpha? [#backgroundalpha]

\> `optional` **backgroundAlpha?**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/background/BackgroundSystem.d.ts:25

Transparency of the background color, value from `0` (fully transparent) to `1` (fully opaque).
This value determines whether the canvas is initialized with alpha transparency support.
Note: This cannot be changed after initialization. If set to `1`, the canvas will remain opaque,
even if a transparent background color is set later.

#### Default [#default-1]

```ts
1
```

#### Inherited from [#inherited-from-4]

`AutoDetectOptions.backgroundAlpha`

***

### backgroundColor [#backgroundcolor]

\> **backgroundColor**: `ColorSource`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/background/BackgroundSystem.d.ts:15

The background color used to clear the canvas. See ColorSource for accepted color values.

#### Default [#default-2]

```ts
'black'
```

#### Inherited from [#inherited-from-5]

`AutoDetectOptions.backgroundColor`

***

### bezierSmoothness [#beziersmoothness]

\> **bezierSmoothness**: `number`

Defined in: node_modules/pixi.js/lib/scene/graphics/GraphicsMixins.d.ts:35

A value from 0 to 1 that controls the smoothness of bezier curves (the higher the smoother)

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-6]

`AutoDetectOptions.bezierSmoothness`

***

### canvas? [#canvas]

\> `optional` **canvas?**: `ICanvas`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:27

The canvas to use as a view, optional.

#### Inherited from [#inherited-from-7]

`AutoDetectOptions.canvas`

***

### canvasOptions? [#canvasoptions]

\> `optional` **canvasOptions?**: `Partial`\<`CanvasOptions`>

Defined in: node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts:32

Optional CanvasOptions to pass only to the Canvas renderer

#### Inherited from [#inherited-from-8]

`AutoDetectOptions.canvasOptions`

***

### clearBeforeRender? [#clearbeforerender]

\> `optional` **clearBeforeRender?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/background/BackgroundSystem.d.ts:30

Whether to clear the canvas before new render passes.

#### Default [#default-4]

```ts
true
```

#### Inherited from [#inherited-from-9]

`AutoDetectOptions.clearBeforeRender`

***

### context [#context]

\> **context**: `WebGL2RenderingContext` | `null`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:29

User-provided WebGL rendering context object.

#### Default [#default-5]

```ts
null
```

#### Inherited from [#inherited-from-10]

`AutoDetectOptions.context`

***

### culler? [#culler]

\> `optional` **culler?**: `object`

Defined in: node_modules/pixi.js/lib/culling/CullerPlugin.d.ts:34

Options for the culler behavior.

#### updateTransform? [#updatetransform]

\> `optional` **updateTransform?**: `boolean`

Update the transform of culled objects.

\> \[!IMPORTANT] Keeping this as `false` can improve performance by avoiding unnecessary calculations,
\> however, the transform used for culling may not be up-to-date if the object has moved since the last render.

##### Default [#default-6]

```ts
true
```

##### Example [#example-2]

```ts
const app = new Application();
await app.init({
    culler: {
        updateTransform: false // Skip updating transforms for culled objects
    }
});
```

#### Example [#example-3]

```ts
// Basic culling options
const app = new Application();
await app.init({
    culler: {...}
});
```

#### Inherited from [#inherited-from-11]

`PixiMixins.ApplicationOptions.culler`

***

### depth? [#depth]

\> `optional` **depth?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:45

Whether to ensure the main view has can make use of the depth buffer. Always true for WebGL renderer.

#### Inherited from [#inherited-from-12]

`AutoDetectOptions.depth`

***

### eventFeatures? [#eventfeatures]

\> `optional` **eventFeatures?**: `Partial`\<`EventSystemFeatures`>

Defined in: node_modules/pixi.js/lib/events/EventsMixins.d.ts:73

Configuration for enabling/disabling specific event features.
Use this to optimize performance by turning off unused functionality.

#### Example [#example-4]

```ts
const app = new Application();
await app.init({
    eventFeatures: {
        // Core interaction events
        move: true,        // Pointer/mouse/touch movement
        click: true,       // Click/tap events
        wheel: true,       // Mouse wheel/scroll events
        // Global tracking
        globalMove: false  // Global pointer movement
    }
});
```

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-13]

`AutoDetectOptions.eventFeatures`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/EventsMixins.d.ts:53

The type of interaction behavior for a Container. This is set via the [Container#eventMode](/pixi-vn/index/classes/VideoSprite#eventmode) property.

#### Example [#example-5]

```ts
// Basic event mode setup
const sprite = new Sprite(texture);
sprite.eventMode = 'static';    // Enable standard interaction
sprite.on('pointerdown', () => { console.log('clicked!'); });

// Different event modes
sprite.eventMode = 'none';      // Disable all interaction
sprite.eventMode = 'passive';   // Only allow interaction on children
sprite.eventMode = 'auto';      // Like DOM pointer-events: auto
sprite.eventMode = 'dynamic';   // For moving/animated objects
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and
  non-interactive children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive.
  Same as `interactive = false` in v7
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7
* `'dynamic'`: Emits events and is hit tested but will also receive mock interaction events fired from
  a ticker to allow for interaction when the mouse isn't moving

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard buttons/controls
* Use `'dynamic'` only for moving/animated interactive elements

#### Since [#since-1]

7.2.0

#### Inherited from [#inherited-from-14]

`AutoDetectOptions.eventMode`

***

### failIfMajorPerformanceCaveat? [#failifmajorperformancecaveat]

\> `optional` **failIfMajorPerformanceCaveat?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/RenderingMixins.d.ts:15

#### Inherited from [#inherited-from-15]

`AutoDetectOptions.failIfMajorPerformanceCaveat`

***

### forceFallbackAdapter [#forcefallbackadapter]

\> **forceFallbackAdapter**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gpu/GpuDeviceSystem.d.ts:41

Force the use of the fallback adapter

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-16]

`AutoDetectOptions.forceFallbackAdapter`

***

### gcActive [#gcactive]

\> **gcActive**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:50

If set to true, this will enable the garbage collector.

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-17]

`AutoDetectOptions.gcActive`

***

### gcFrequency [#gcfrequency]

\> **gcFrequency**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:60

How frequently to run garbage collection in milliseconds.

#### Default [#default-9]

```ts
30000
```

#### Inherited from [#inherited-from-18]

`AutoDetectOptions.gcFrequency`

***

### gcMaxUnusedTime [#gcmaxunusedtime]

\> **gcMaxUnusedTime**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:55

The maximum time in milliseconds a resource can be unused before being garbage collected.

#### Default [#default-10]

```ts
60000
```

#### Inherited from [#inherited-from-19]

`AutoDetectOptions.gcMaxUnusedTime`

***

### gpu? [#gpu]

\> `optional` **gpu?**: `GPU`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gpu/GpuDeviceSystem.d.ts:43

Using shared device and adaptor from other engine

#### Inherited from [#inherited-from-20]

`AutoDetectOptions.gpu`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:25

The height of the screen.

#### Default [#default-11]

```ts
600
```

#### Inherited from [#inherited-from-21]

`AutoDetectOptions.height`

***

### hello [#hello]

\> **hello**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/startup/HelloSystem.d.ts:15

Whether to log the version and type information of renderer to console.

#### Default [#default-12]

```ts
false
```

#### Inherited from [#inherited-from-22]

`AutoDetectOptions.hello`

***

### ~~manageImports?~~ [#manageimports]

\> `optional` **manageImports?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/SharedSystems.d.ts:74

#### Default [#default-13]

```ts
true
```

#### Deprecated [#deprecated]

since 8.1.6

#### See [#see-1]

`skipExtensionImports`

#### Inherited from [#inherited-from-23]

`AutoDetectOptions.manageImports`

***

### multiView [#multiview]

\> **multiView**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:60

Whether to enable multi-view rendering. Set to true when rendering to multiple
canvases on the dom.

#### Default [#default-14]

```ts
false
```

#### Inherited from [#inherited-from-24]

`AutoDetectOptions.multiView`

***

### powerPreference? [#powerpreference]

\> `optional` **powerPreference?**: `GpuPowerPreference`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:37

An optional hint indicating what configuration of GPU is suitable for the WebGL context,
can be `'high-performance'` or `'low-power'`.
Setting to `'high-performance'` will prioritize rendering performance over power consumption,
while setting to `'low-power'` will prioritize power saving over rendering performance.

#### Default [#default-15]

```ts
undefined
```

#### Inherited from [#inherited-from-25]

`AutoDetectOptions.powerPreference`

***

### preference? [#preference]

\> `optional` **preference?**: `RendererPreference` | `RendererPreference`\[]

Defined in: node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts:26

The preferred renderer type(s).

* When a **string** is provided (e.g. `'webgpu'`), that renderer is tried first and
  the remaining renderers are used as fallbacks in the default priority order.
* When an **array** is provided (e.g. `['webgpu', 'webgl']`), only the listed
  renderers are tried, in the given order. Any renderer type **not** in the array
  is excluded entirely — this can be used as a blocklist.

#### Inherited from [#inherited-from-26]

`AutoDetectOptions.preference`

***

### preferWebGLVersion? [#preferwebglversion]

\> `optional` **preferWebGLVersion?**: `1` | `2`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:54

The preferred WebGL version to use.

#### Default [#default-16]

```ts
2
```

#### Inherited from [#inherited-from-27]

`AutoDetectOptions.preferWebGLVersion`

***

### premultipliedAlpha [#premultipliedalpha]

\> **premultipliedAlpha**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:42

Whether the compositor will assume the drawing buffer contains colors with premultiplied alpha.

#### Default [#default-17]

```ts
true
```

#### Inherited from [#inherited-from-28]

`AutoDetectOptions.premultipliedAlpha`

***

### preserveDrawingBuffer [#preservedrawingbuffer]

\> **preserveDrawingBuffer**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:48

Whether to enable drawing buffer preservation. If enabled, the drawing buffer will preserve
its value until cleared or overwritten. Enable this if you need to call `toDataUrl` on the WebGL context.

#### Default [#default-18]

```ts
false
```

#### Inherited from [#inherited-from-29]

`AutoDetectOptions.preserveDrawingBuffer`

***

### renderableGCActive [#renderablegcactive]

\> **renderableGCActive**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/RenderableGCSystem.d.ts:20

If set to true, this will enable the garbage collector on the GPU.

#### Default [#default-19]

```ts
true
```

#### Inherited from [#inherited-from-30]

`AutoDetectOptions.renderableGCActive`

***

### renderableGCFrequency [#renderablegcfrequency]

\> **renderableGCFrequency**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/RenderableGCSystem.d.ts:30

Frames between two garbage collections.

#### Default [#default-20]

```ts
600
```

#### Inherited from [#inherited-from-31]

`AutoDetectOptions.renderableGCFrequency`

***

### renderableGCMaxUnusedTime [#renderablegcmaxunusedtime]

\> **renderableGCMaxUnusedTime**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/RenderableGCSystem.d.ts:25

The maximum idle frames before a texture is destroyed by garbage collection.

#### Default [#default-21]

```ts
60 * 60
```

#### Inherited from [#inherited-from-32]

`AutoDetectOptions.renderableGCMaxUnusedTime`

***

### resizeTo? [#resizeto]

\> `optional` **resizeTo?**: `HTMLElement` | `Window`

Defined in: node_modules/pixi.js/lib/app/ResizePlugin.d.ts:34

Element to automatically resize the renderer to.

#### Example [#example-6]

```ts
const app = new Application();
await app.init({
    resizeTo: window, // Resize to the entire window
    // or
    resizeTo: document.querySelector('#game-container'), // Resize to a specific element
    // or
    resizeTo: null, // Disable auto-resize
});
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

`PixiMixins.ApplicationOptions.resizeTo`

***

### resolution? [#resolution]

\> `optional` **resolution?**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:41

The resolution / device pixel ratio of the renderer.

#### Inherited from [#inherited-from-34]

`AutoDetectOptions.resolution`

***

### roundPixels? [#roundpixels]

\> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/RenderingMixins.d.ts:16

#### Inherited from [#inherited-from-35]

`AutoDetectOptions.roundPixels`

***

### sharedTicker? [#sharedticker]

\> `optional` **sharedTicker?**: `boolean`

Defined in: node_modules/pixi.js/lib/app/TickerPlugin.d.ts:80

Controls whether to use the shared global ticker or create a new instance.

The shared ticker is useful when you have multiple instances that should sync their updates.
However, it has some limitations regarding update order control.

Update Order:

1. System ticker (always runs first)
2. Shared ticker (if enabled)
3. App ticker (if using own ticker)

#### Example [#example-7]

```ts
// Use shared ticker (global instance)
await app.init({ sharedTicker: true });

// Use dedicated ticker (default)
await app.init({ sharedTicker: false });

// Access ticker properties
console.log(app.ticker.FPS);    // Current FPS
console.log(app.ticker.deltaMS); // MS since last update
```

#### Default [#default-23]

```ts
false
```

#### Inherited from [#inherited-from-36]

`PixiMixins.ApplicationOptions.sharedTicker`

***

### skipExtensionImports? [#skipextensionimports]

\> `optional` **skipExtensionImports?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/SharedSystems.d.ts:68

Whether to stop PixiJS from dynamically importing default extensions for the renderer.
It is false by default, and means PixiJS will load all the default extensions, based
on the environment e.g browser/webworker.
If you set this to true, then you will need to manually import the systems and extensions you need.
Renderer loader extensions (`WebGLLoader`, `WebGPULoader`, `CanvasLoader`) are skipped too.

e.g.

```js
import 'accessibility';
import 'app';
import 'events';
import 'spritesheet';
import 'graphics';
import 'mesh';
import 'text';
import 'text-bitmap';
import 'text-html';
import { autoDetectRenderer } from 'pixi.js';

const renderer = await autoDetectRenderer({
  width: 800,
  height: 600,
  skipExtensionImports: true,
});
```

#### Default [#default-24]

```ts
false
```

#### Inherited from [#inherited-from-37]

`AutoDetectOptions.skipExtensionImports`

***

### ~~textureGCActive~~ [#texturegcactive]

\> **textureGCActive**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:17

If set to true, this will enable the garbage collector on the GPU.

#### Default [#default-25]

```ts
true
```

#### Deprecated [#deprecated-1]

since 8.15.0

#### Inherited from [#inherited-from-38]

`AutoDetectOptions.textureGCActive`

***

### ~~textureGCAMaxIdle~~ [#texturegcamaxidle]

\> **textureGCAMaxIdle**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:22

#### Deprecated [#deprecated-2]

since 8.3.0

#### See [#see-2]

[TextureGCSystemOptions.textureGCMaxIdle](#texturegcmaxidle)

#### Inherited from [#inherited-from-39]

`AutoDetectOptions.textureGCAMaxIdle`

***

### ~~textureGCCheckCountMax~~ [#texturegccheckcountmax]

\> **textureGCCheckCountMax**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:34

Frames between two garbage collections.

#### Default [#default-26]

```ts
600
```

#### Deprecated [#deprecated-3]

since 8.15.0

#### Inherited from [#inherited-from-40]

`AutoDetectOptions.textureGCCheckCountMax`

***

### ~~textureGCMaxIdle~~ [#texturegcmaxidle]

\> **textureGCMaxIdle**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:28

The maximum idle frames before a texture is destroyed by garbage collection.

#### Default [#default-27]

```ts
60 * 60
```

#### Deprecated [#deprecated-4]

since 8.15.0

#### Inherited from [#inherited-from-41]

`AutoDetectOptions.textureGCMaxIdle`

***

### useBackBuffer? [#usebackbuffer]

\> `optional` **useBackBuffer?**: `boolean`

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/GlBackBufferSystem.d.ts:17

if true will use the back buffer where required

#### Default [#default-28]

```ts
false
```

#### Inherited from [#inherited-from-42]

`AutoDetectOptions.useBackBuffer`

***

### ~~view?~~ [#view]

\> `optional` **view?**: `ICanvas`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:32

Alias for `canvas`.

#### Deprecated [#deprecated-5]

since 8.0.0

#### Inherited from [#inherited-from-43]

`AutoDetectOptions.view`

***

### webgl? [#webgl]

\> `optional` **webgl?**: `Partial`\<`WebGLOptions`>

Defined in: node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts:30

Optional WebGLOptions to pass only to the WebGL renderer

#### Inherited from [#inherited-from-44]

`AutoDetectOptions.webgl`

***

### webgpu? [#webgpu]

\> `optional` **webgpu?**: `Partial`\<`WebGPUOptions`>

Defined in: node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts:28

Optional WebGPUOptions to pass only to WebGPU renderer.

#### Inherited from [#inherited-from-45]

`AutoDetectOptions.webgpu`

***

### width? [#width]

\> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/view/ViewSystem.d.ts:20

The width of the screen.

#### Default [#default-29]

```ts
800
```

#### Inherited from [#inherited-from-46]

`AutoDetectOptions.width`


# Interface: AssetMemory (/pixi-vn/index/interfaces/AssetMemory)



Defined in: [src/canvas/interfaces/AssetMemory.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/AssetMemory.ts#L4)

Interface for Asset memory

## Properties [#properties]

### alias? [#alias]

\> `optional` **alias?**: `string`

Defined in: [src/canvas/interfaces/AssetMemory.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/AssetMemory.ts#L5)

***

### url [#url]

\> **url**: `string`

Defined in: [src/canvas/interfaces/AssetMemory.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/AssetMemory.ts#L6)


# Interface: AssetsBundle (/pixi-vn/index/interfaces/AssetsBundle)



Defined in: node_modules/pixi.js/lib/assets/types.d.ts:258

Structure of a bundle found in a [AssetsManifest](/pixi-vn/index/interfaces/AssetsManifest) file. Bundles allow you to
group related assets together for easier management and loading.

## Example [#example]

```ts
// Basic bundle structure
const bundle: AssetsBundle = {
    name: 'level-1',
    assets: [
        {
            alias: 'background',
            src: 'level1/bg.{webp,png}'
        },
        {
            alias: 'sprites',
            src: 'level1/sprites.json'
        }
    ]
};

// Using object format for assets
const bundle: AssetsBundle = {
    name: 'ui',
    assets: {
        button: 'ui/button.png',
        panel: 'ui/panel.png',
        icons: ['ui/icons.webp', 'ui/icons.png']
    }
};
```

## See [#see]

* Assets.addBundle For adding bundles programmatically
* Assets.loadBundle For loading bundles

## Standard [#standard]

## Properties [#properties]

### assets [#assets]

\> **assets**: [`UnresolvedAsset`](/pixi-vn/index/interfaces/UnresolvedAsset)\<`any`>\[] | `Record`\<`string`, `ArrayOr`\<`string`> | [`UnresolvedAsset`](/pixi-vn/index/interfaces/UnresolvedAsset)\<`any`>>

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:262

Assets contained in the bundle. Can be an array of assets or a record mapping aliases to sources.

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:260

Unique identifier for the bundle


# Interface: AssetsManifest (/pixi-vn/index/interfaces/AssetsManifest)



Defined in: node_modules/pixi.js/lib/assets/types.d.ts:308

The manifest format for defining all assets in your application. Manifests provide a
structured way to organize and manage your assets through bundles.

## Example [#example]

```ts
const manifest: AssetsManifest = {
    bundles: [
        {
            name: 'loading',
            assets: [
                {
                    alias: 'logo',
                    src: 'logo.{webp,png}',
                    data: { scaleMode: 'nearest' }
                },
                {
                    alias: 'progress-bar',
                    src: 'progress.png'
                }
            ]
        },
        {
            name: 'game',
            assets: {
                background: ['bg.webp', 'bg.png'],
                character: 'hero.json',
                music: 'theme.mp3'
            }
        }
    ]
};

// Initialize with manifest
await Assets.init({ manifest });

// Load bundles as needed
await Assets.loadBundle('loading');
await Assets.loadBundle('game');
```

## See [#see]

* Assets.init For initializing with a manifest
* [AssetsBundle](/pixi-vn/index/interfaces/AssetsBundle) For bundle structure details

## Standard [#standard]

## Properties [#properties]

### bundles [#bundles]

\> **bundles**: [`AssetsBundle`](/pixi-vn/index/interfaces/AssetsBundle)\[]

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:310

Array of asset bundles that make up the manifest


# Interface: AudioChannelInterface (/pixi-vn/index/interfaces/AudioChannelInterface)



Defined in: [src/sound/interfaces/AudioChannelInterface.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L5)

## Properties [#properties]

### alias [#alias]

\> `readonly` **alias**: `string`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L9)

The alias of the audio channel. This is used to reference the channel when playing sounds. The alias must be unique among all channels.

***

### background [#background]

\> `readonly` **background**: `boolean`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L54)

Whether this channel is a background channel.
Background channels are special channels. Unlike normal channels, media connected to a background channel does not stop when a scene changes, but continues to play in the background.

***

### mediaInstances [#mediainstances]

\> `readonly` **mediaInstances**: [`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)\[]

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L49)

The MediaInstances currently playing through this channel. This is read-only and cannot be modified directly. Use the play method to add new MediaInstances to this channel.

***

### muted [#muted]

\> **muted**: `boolean`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L45)

Whether the audio channel is muted. This is combined with the muted state of each sound played through this channel.

***

### pan [#pan]

\> **pan**: `number`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L37)

The stereo pan position for this channel in the range \[-1, 1].
-1 is full left, 0 is centre, 1 is full right.

***

### panParam [#panparam]

\> `readonly` **panParam**: `Param`\<`"audioRange"`>

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:141](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L141)

**Advanced** — the raw `Tone.Param<"audioRange">` for this channel's
stereo pan position.

Unlike the [pan](#pan) property (which sets the value instantly), this
Param exposes all Tone.js automation methods such as `rampTo`,
`linearRampTo`, and `exponentialRampTo`.

Use this when you need to smoothly automate panning over time instead of
setting it instantly.  Values range from -1 (full left) to 1 (full right).

#### Example [#example]

```ts
const channel = sound.channels.find("music");

// Gradually pan to the left over 3 seconds.
channel.panParam.rampTo(-1, 3);

// Return to centre over 2 seconds.
channel.panParam.rampTo(0, 2);
```

***

### volume [#volume]

\> **volume**: `number`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L41)

The volume of the audio channel, between 0 and 1. This is multiplied with the volume of each sound played through this channel.

***

### volumeParam [#volumeparam]

\> `readonly` **volumeParam**: `Param`\<`"decibels"`>

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:118](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L118)

**Advanced** — the raw `Tone.Param<"decibels">` for this channel's volume.

Unlike the [volume](#volume) property (which uses a linear 0–1 scale), this
Param works directly in **decibels** and exposes all Tone.js automation
methods such as `rampTo`, `linearRampTo`, and `exponentialRampTo`.

Use this when you need to smoothly automate volume over time instead of
setting it instantly.

#### Example [#example-1]

```ts
const channel = sound.channels.find("music");

// Fade the volume from its current level to -12 dB over 3 seconds.
channel.volumeParam.rampTo(-12, 3);

// Fade to silence over 2 seconds.
channel.volumeParam.rampTo(-Infinity, 2);
```

## Methods [#methods]

### chain() [#chain]

\> **chain**(...`nodes`): `this`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:96](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L96)

Useful for inserting channel-wide audio effects such as reverb, delay or EQ.

Install "tone" to use this method.

#### Parameters [#parameters]

##### nodes [#nodes]

...`ToneAudioNode`\<`ToneWithContextOptions`>\[]

One or more Tone.js ToneAudioNode instances to chain in series.

#### Returns [#returns]

`this`

Instance for chaining.

#### Example [#example-2]

```ts
import * as Tone from "tone";

const channel = sound.channels.find("music");

// Create a reverb effect and wait for its impulse response to be ready.
const reverb = new Tone.Reverb({ decay: 2.5 });

// Route the channel through the reverb to the master output.
channel.chain(reverb);
```

***

### pauseAll() [#pauseall]

\> **pauseAll**(): `this`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L64)

Pauses any playing sounds.

#### Returns [#returns-1]

`this`

Instance for chaining.

***

### play() [#play]

#### Call Signature [#call-signature]

\> **play**(`alias`, `options?`): `Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L18)

Plays a sound.

##### Parameters [#parameters-1]

###### alias [#alias-1]

`string`

The media and sound (asset) alias reference.

###### options? [#options]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

The options

##### Returns [#returns-2]

`Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

The sound instance,
this cannot be reused after it is done playing. Returns a Promise if the sound
has not yet loaded.

#### Call Signature [#call-signature-1]

\> **play**(`mediaAlias`, `soundAlias`, `options?`): `Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L28)

Plays a sound.

##### Parameters [#parameters-2]

###### mediaAlias [#mediaalias]

`string`

The media alias reference.

###### soundAlias [#soundalias]

`string`

The sound (asset) alias reference.

###### options? [#options-1]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

The options

##### Returns [#returns-3]

`Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

The sound instance,
this cannot be reused after it is done playing. Returns a Promise if the sound
has not yet loaded.

***

### resumeAll() [#resumeall]

\> **resumeAll**(): `this`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L69)

Resumes any sounds.

#### Returns [#returns-4]

`this`

Instance for chaining.

***

### stopAll() [#stopall]

\> **stopAll**(): `this`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L59)

Stops all media currently playing through this channel.

#### Returns [#returns-5]

`this`

Instance for chaining.

***

### toggleMuteAll() [#togglemuteall]

\> **toggleMuteAll**(): `boolean`

Defined in: [src/sound/interfaces/AudioChannelInterface.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/AudioChannelInterface.ts#L74)

Toggle muted property for all sounds.

#### Returns [#returns-6]

`boolean`

`true` if all sounds are muted.


# Interface: BlurInOutProps (/pixi-vn/index/interfaces/BlurInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:132](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L132)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:149](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L149)

Whether the component itself also briefly fades in (`blurIn`) or out (`blurOut`) alongside the
blur, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a quarter of
the effect's own duration, mirrored to the start of `blurIn` or the end of `blurOut`.

#### Default [#default-3]

```ts
true
```

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### quality? [#quality]

\> `optional` **quality?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:142](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L142)

The quality (number of blur passes) of the blur filter. Higher is smoother but slower.

#### Default [#default-5]

```ts
4
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:137](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L137)

The blur strength the effect starts from (`blurIn`) or ends at (`blurOut`).

#### Default [#default-7]

```ts
32
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: BlurPulseEffectProps (/pixi-vn/index/interfaces/BlurPulseEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:280](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L280)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### pulses? [#pulses]

\> `optional` **pulses?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:290](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L290)

The number of pulses.

#### Default [#default-5]

```ts
3
```

***

### quality? [#quality]

\> `optional` **quality?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:296](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L296)

The blur filter's own render quality (number of blur passes). Higher looks smoother but costs
more to render.

#### Default [#default-6]

```ts
4
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:285](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L285)

The peak blur strength of the first, largest pulse.

#### Default [#default-8]

```ts
8
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: BounceEffectProps (/pixi-vn/index/interfaces/BounceEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L38)

Shared options for the generic, repeated articulated-animation effects (BounceEffectProps,
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounces? [#bounces]

\> `optional` **bounces?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L53)

The number of bounces.

#### Default [#default-1]

```ts
4
```

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/effect-props.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L43)

The direction the component displaces towards on each bounce, before returning to rest.

#### Default [#default-5]

```ts
"up"
```

***

### distance? [#distance]

\> `optional` **distance?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:48](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L48)

The distance (in pixels) of the first, largest bounce.

#### Default [#default-6]

```ts
30
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-7]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-8]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: CanvasBaseInterface<T2> (/pixi-vn/index/interfaces/CanvasBaseInterface)



Defined in: [src/canvas/interfaces/CanvasBaseInterface.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasBaseInterface.ts#L5)

This class is used to create a canvas element to add into a Pixi Application.
You can use [()](/pixi-vn/index/interfaces/CanvasManagerInterface#add) to add this element into the application.
This class should be implemented and the memory method should be overridden.
You must use the [canvasComponentDecorator](/pixi-vn/index/namespaces/RegisteredCanvasComponents) to register the canvas in the game.
In Ren'Py is a displayable.

## Example [#example]

```ts
const CANVAS_EXAMPLE_ID = "CanvasExample";

\@canvasComponentDecorator({
    name: CANVAS_EXAMPLE_ID,
})
export class CanvasExample extends Container implements CanvasBaseItem<Memory> {
    get memory(): Memory {
        return {
            pixivnId: CANVAS_EXAMPLE_ID,
            // ... other properties
        }
    }
    async setMemory(value: Memory) {
        // ... set other properties
    }
}
```

## Extends [#extends]

* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`T2`>.`Container`

## Type Parameters [#type-parameters]

### T2 [#t2]

`T2` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

`PixiContainer.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

`PixiContainer.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

`PixiContainer.__devtoolLocked`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-3]

`PixiContainer._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-4]

`PixiContainer._cy`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-5]

`PixiContainer._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-6]

`PixiContainer._position`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-7]

`PixiContainer._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-8]

`PixiContainer._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-9]

`PixiContainer._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-10]

`PixiContainer._sy`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-11]

`PixiContainer._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-12]

`PixiContainer.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-13]

`PixiContainer.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-14]

`PixiContainer.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-15]

`PixiContainer.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-16]

`PixiContainer.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-17]

`PixiContainer.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-18]

`PixiContainer.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:10

**`Internal`**

#### Inherited from [#inherited-from-19]

`PixiContainer.allowChildren`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-20]

`PixiContainer.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-21]

`PixiContainer.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cached content
* [Container#isCachedAsTexture](/pixi-vn/index/classes/VideoSprite#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-22]

`PixiContainer.cacheAsTexture`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-23]

`PixiContainer.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-24]

`PixiContainer.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-25]

`PixiContainer.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-26]

`PixiContainer.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-27]

`PixiContainer.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-28]

`PixiContainer.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

[Container#destroy](/pixi-vn/index/classes/Container#destroy) For destroying objects

#### Inherited from [#inherited-from-29]

`PixiContainer.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-30]

`PixiContainer.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-31]

`PixiContainer.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* [Container#filters](/pixi-vn/index/classes/VideoSprite#filters) For applying filters
* [Rectangle](/pixi-vn/index/variables/Rectangle) For area definition

#### Inherited from [#inherited-from-32]

`PixiContainer.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-33]

`PixiContainer.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-34]

`PixiContainer.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-35]

`PixiContainer.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-36]

`PixiContainer.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-37]

`PixiContainer.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-38]

`PixiContainer.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-39]

`PixiContainer.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-40]

`PixiContainer.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-41]

`PixiContainer.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* [Container#cacheAsTexture](/pixi-vn/index/classes/Container#cacheastexture) For enabling caching
* [Container#updateCacheTexture](/pixi-vn/index/classes/Container#updatecachetexture) For updating cache

#### Inherited from [#inherited-from-42]

`PixiContainer.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-2]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-43]

`PixiContainer.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-45]

`PixiContainer.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-46]

`PixiContainer.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-47]

`PixiContainer.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-48]

`PixiContainer.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-49]

`PixiContainer.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn/index/classes/VideoSprite#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn/index/classes/VideoSprite#grouptransform) For render group transform

#### Inherited from [#inherited-from-50]

`PixiContainer.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a [Sprite](/pixi-vn/index/classes/Sprite) object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* [Sprite](/pixi-vn/index/classes/Sprite) For texture-based masks
* [Container#setMask](/pixi-vn/index/classes/VideoSprite#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-51]

`PixiContainer.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-52]

`PixiContainer.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-53]

`PixiContainer.onclick`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-54]

`PixiContainer.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-55]

`PixiContainer.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-56]

`PixiContainer.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-57]

`PixiContainer.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-58]

`PixiContainer.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-59]

`PixiContainer.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-60]

`PixiContainer.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-61]

`PixiContainer.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-62]

`PixiContainer.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-63]

`PixiContainer.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-64]

`PixiContainer.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-65]

`PixiContainer.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-66]

`PixiContainer.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-67]

`PixiContainer.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-68]

`PixiContainer.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-69]

`PixiContainer.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-70]

`PixiContainer.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-71]

`PixiContainer.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-72]

`PixiContainer.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-73]

`PixiContainer.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-74]

`PixiContainer.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-75]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-76]

`PixiContainer.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-77]

`PixiContainer.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-78]

`PixiContainer.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-79]

`PixiContainer.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-80]

`PixiContainer.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-81]

`PixiContainer.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-82]

`PixiContainer.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-83]

`PixiContainer.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-84]

`PixiContainer.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-85]

`PixiContainer.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-86]

`PixiContainer.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-87]

`PixiContainer.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-88]

`PixiContainer.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> **pixivnId**: `string` = `"canvas_element_id_not_set"`

Defined in: [src/canvas/classes/CanvasBaseItem.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L56)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Inherited from [#inherited-from-89]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`pixivnId`](/pixi-vn/index/classes/CanvasBaseItem#pixivnid)

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-90]

`PixiContainer.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:800

**`Internal`**

#### Inherited from [#inherited-from-91]

`PixiContainer.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-92]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-3]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn/index/classes/VideoSprite#zindex) For setting child order

#### Inherited from [#inherited-from-93]

`PixiContainer.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-94]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-95]

`PixiContainer.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-96]

`PixiContainer.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-4]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-97]

`PixiContainer.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-98]

`PixiContainer.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-99]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)

## Accessors [#accessors]

### alpha [#alpha]

#### Get Signature [#get-signature]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

##### Returns [#returns-5]

`number`

#### Set Signature [#set-signature]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-1]

###### value [#value]

`number`

##### Returns [#returns-6]

`void`

#### Inherited from [#inherited-from-100]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`alpha`](/pixi-vn/index/classes/VideoSprite#alpha)

***

### angle [#angle]

#### Get Signature [#get-signature-1]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-7]

`number`

#### Set Signature [#set-signature-1]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-2]

###### value [#value-1]

`number`

##### Returns [#returns-8]

`void`

#### Inherited from [#inherited-from-101]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`angle`](/pixi-vn/index/classes/VideoSprite#angle)

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-2]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

##### Returns [#returns-9]

`BLEND_MODES`

#### Set Signature [#set-signature-2]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-3]

###### value [#value-2]

`BLEND_MODES`

##### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-102]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`blendMode`](/pixi-vn/index/classes/VideoSprite#blendmode)

***

### filters [#filters]

#### Get Signature [#get-signature-3]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-68]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-16]

Filter For filter base class

##### Returns [#returns-11]

readonly `Filter`\[]

#### Set Signature [#set-signature-3]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-17]

Filter For filter base class

##### Parameters [#parameters-4]

###### value [#value-3]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-103]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`filters`](/pixi-vn/index/classes/VideoSprite#filters)

***

### height [#height]

#### Get Signature [#get-signature-4]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-70]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-13]

`number`

#### Set Signature [#set-signature-4]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-5]

###### value [#value-4]

`number`

##### Returns [#returns-14]

`void`

#### Inherited from [#inherited-from-104]

[`ImageContainer`](/pixi-vn/index/classes/ImageContainer).[`height`](/pixi-vn/index/classes/ImageContainer#height)

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-5]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-15]

`boolean`

#### Inherited from [#inherited-from-105]

`PixiContainer.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-6]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-16]

`boolean`

#### Set Signature [#set-signature-5]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-6]

###### value [#value-5]

`boolean`

##### Returns [#returns-17]

`void`

#### Inherited from [#inherited-from-106]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`isRenderGroup`](/pixi-vn/index/classes/VideoSprite#isrendergroup)

***

### memory [#memory]

#### Get Signature [#get-signature-7]

\> **get** **memory**(): `T2`

Defined in: [src/canvas/classes/CanvasBaseItem.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L37)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-18]

`T2`

#### Inherited from [#inherited-from-107]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`memory`](/pixi-vn/index/classes/CanvasBaseItem#memory)

***

### origin [#origin]

#### Get Signature [#get-signature-8]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-71]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-19]

`ObservablePoint`

#### Set Signature [#set-signature-6]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-7]

###### value [#value-6]

`number` | `PointData`

##### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-108]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`origin`](/pixi-vn/index/classes/VideoSprite#origin)

***

### pivot [#pivot]

#### Get Signature [#get-signature-9]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-72]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-21]

`ObservablePoint`

#### Set Signature [#set-signature-7]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-8]

###### value [#value-7]

`number` | `PointData`

##### Returns [#returns-22]

`void`

#### Inherited from [#inherited-from-109]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`pivot`](/pixi-vn/index/classes/VideoSprite#pivot)

***

### position [#position]

#### Get Signature [#get-signature-10]

\> **get** **position**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:959

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-73]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-23]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **position**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:960

##### Parameters [#parameters-9]

###### value [#value-8]

`PointData`

##### Returns [#returns-24]

`void`

#### Inherited from [#inherited-from-110]

`CanvasBaseInterface`.[`position`](#position)

***

### renderable [#renderable]

#### Get Signature [#get-signature-11]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-74]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-18]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-25]

`boolean`

#### Set Signature [#set-signature-9]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-10]

###### value [#value-9]

`boolean`

##### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-111]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`renderable`](/pixi-vn/index/classes/VideoSprite#renderable)

***

### rotation [#rotation]

#### Get Signature [#get-signature-12]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-75]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-27]

`number`

#### Set Signature [#set-signature-10]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-11]

###### value [#value-10]

`number`

##### Returns [#returns-28]

`void`

#### Inherited from [#inherited-from-112]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`rotation`](/pixi-vn/index/classes/VideoSprite#rotation)

***

### scale [#scale]

#### Get Signature [#get-signature-13]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-76]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-4]

4.0.0

##### Returns [#returns-29]

`ObservablePoint`

#### Set Signature [#set-signature-11]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-12]

###### value [#value-11]

`string` | `number` | `PointData`

##### Returns [#returns-30]

`void`

#### Inherited from [#inherited-from-113]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`scale`](/pixi-vn/index/classes/VideoSprite#scale)

***

### skew [#skew]

#### Get Signature [#get-signature-14]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-77]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-5]

4.0.0

##### Default [#default-55]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-31]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-13]

###### value [#value-12]

`PointData`

##### Returns [#returns-32]

`void`

#### Inherited from [#inherited-from-114]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`skew`](/pixi-vn/index/classes/VideoSprite#skew)

***

### tint [#tint]

#### Get Signature [#get-signature-15]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-78]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-56]

```ts
0xFFFFFF
```

##### See [#see-19]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

##### Returns [#returns-33]

`number`

#### Set Signature [#set-signature-13]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-14]

###### value [#value-13]

`ColorSource`

##### Returns [#returns-34]

`void`

#### Inherited from [#inherited-from-115]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`tint`](/pixi-vn/index/classes/VideoSprite#tint)

***

### visible [#visible]

#### Get Signature [#get-signature-16]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-79]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-57]

```ts
true
```

##### See [#see-20]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

##### Returns [#returns-35]

`boolean`

#### Set Signature [#set-signature-14]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-15]

###### value [#value-14]

`boolean`

##### Returns [#returns-36]

`void`

#### Inherited from [#inherited-from-116]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`visible`](/pixi-vn/index/classes/VideoSprite#visible)

***

### width [#width]

#### Get Signature [#get-signature-17]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use [Container#setSize](/pixi-vn/index/classes/Container#setsize)
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-80]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-37]

`number`

#### Set Signature [#set-signature-15]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-16]

###### value [#value-15]

`number`

##### Returns [#returns-38]

`void`

#### Inherited from [#inherited-from-117]

[`ImageContainer`](/pixi-vn/index/classes/ImageContainer).[`width`](/pixi-vn/index/classes/ImageContainer#width)

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-18]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-81]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-21]

[Container#localTransform](/pixi-vn/index/classes/VideoSprite#localtransform) For local space transform

##### Returns [#returns-39]

`Matrix`

#### Inherited from [#inherited-from-118]

`PixiContainer.worldTransform`

***

### x [#x]

#### Get Signature [#get-signature-19]

\> **get** **x**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:933

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-82]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-40]

`number`

#### Set Signature [#set-signature-16]

\> **set** **x**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:934

##### Parameters [#parameters-17]

###### value [#value-16]

`number`

##### Returns [#returns-41]

`void`

#### Inherited from [#inherited-from-119]

`CanvasBaseInterface`.[`x`](#x)

***

### y [#y]

#### Get Signature [#get-signature-20]

\> **get** **y**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:945

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-83]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-42]

`number`

#### Set Signature [#set-signature-17]

\> **set** **y**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:946

##### Parameters [#parameters-18]

###### value [#value-17]

`number`

##### Returns [#returns-43]

`void`

#### Inherited from [#inherited-from-120]

`CanvasBaseInterface`.[`y`](#y)

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-19]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-121]

`PixiContainer._getGlobalBoundsRecursive`

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-20]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-45]

`U`\[`0`]

The first child that was added

#### Example [#example-84]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-22]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For adding at specific index

#### Inherited from [#inherited-from-122]

`PixiContainer.addChild`

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-21]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-46]

`U`

The child that was added

#### Example [#example-85]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-23]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to the end
* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For moving existing children

#### Inherited from [#inherited-from-123]

`PixiContainer.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-22]

###### type [#type]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-47]

`void`

##### Example [#example-86]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-124]

`PixiContainer.addEventListener`

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-23]

###### type [#type-1]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-1]

`AddListenerOptions`

##### Returns [#returns-48]

`void`

##### Inherited from [#inherited-from-125]

`PixiContainer.addEventListener`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-24]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-49]

`this`

#### Inherited from [#inherited-from-126]

`PixiContainer.addListener`

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-25]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-50]

`void`

#### Inherited from [#inherited-from-127]

`PixiContainer.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:30

**`Internal`**

Collects renderables using a simple method, suitable for containers marked as simple.
This method iterates over the container's children and adds their renderables to the instruction set.

#### Parameters [#parameters-26]

##### instructionSet [#instructionset-1]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-1]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-51]

`void`

#### Inherited from [#inherited-from-128]

`PixiContainer.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-27]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-52]

`void`

#### Inherited from [#inherited-from-129]

`PixiContainer.collectRenderablesWithEffects`

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1343

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling `destroy`.

#### Parameters [#parameters-28]

##### options? [#options-2]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-53]

`void`

#### Example [#example-87]

```ts
container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });
```

#### Inherited from [#inherited-from-130]

`PixiContainer.destroy`

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-54]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-131]

`PixiContainer.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this [Container](/pixi-vn/index/classes/Container) using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-29]

##### e [#e]

[`FederatedEvent`](/pixi-vn/index/interfaces/FederatedEvent)

The event to dispatch.

#### Returns [#returns-55]

`boolean`

Whether the [preventDefault](/pixi-vn/index/interfaces/FederatedEvent#preventdefault)() method was not invoked.

#### Example [#example-88]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-132]

`PixiContainer.dispatchEvent`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-30]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-56]

`boolean`

#### Inherited from [#inherited-from-133]

`PixiContainer.emit`

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-57]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-134]

`PixiContainer.enableRenderGroup`

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-58]

(keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-135]

`PixiContainer.eventNames`

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-31]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-1]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-59]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-89]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-24]

* [Container#getLocalBounds](/pixi-vn/index/classes/VideoSprite#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-136]

`PixiContainer.getBounds`

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-32]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-60]

`U`

The child at the given index

#### Example [#example-90]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-25]

* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access
* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For name-based lookup

#### Inherited from [#inherited-from-137]

`PixiContainer.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-33]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-61]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-91]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-26]

* [Container#getChildrenByLabel](/pixi-vn/index/classes/Container#getchildrenbylabel) For finding all matches
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

#### Inherited from [#inherited-from-138]

`PixiContainer.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-34]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-62]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-27]

Container#getChildByLabel

#### Inherited from [#inherited-from-139]

`PixiContainer.getChildByName`

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-35]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-63]

`number`

The index position of the child container

#### Example [#example-92]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-28]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For changing index
* [Container#children](/pixi-vn/index/classes/Container#children) For direct array access

#### Inherited from [#inherited-from-140]

`PixiContainer.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-36]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-64]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-93]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-29]

* [Container#getChildByLabel](/pixi-vn/index/classes/Container#getchildbylabel) For finding first match
* [Container#label](/pixi-vn/index/classes/VideoSprite#label) For setting labels

#### Inherited from [#inherited-from-141]

`PixiContainer.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-37]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-2]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-65]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-142]

`PixiContainer.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-38]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-66]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-94]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-143]

`PixiContainer.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-39]

##### point? [#point]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-67]

`Point`

The updated point

#### Example [#example-95]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-30]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For converting to local space

#### Inherited from [#inherited-from-144]

`PixiContainer.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-40]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-68]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-96]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-145]

`PixiContainer.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-41]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-69]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-97]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-146]

`PixiContainer.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-70]

`Bounds`

The bounding area

#### Example [#example-98]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-31]

* [Container#getBounds](/pixi-vn/index/classes/VideoSprite#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-147]

`PixiContainer.getLocalBounds`

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-42]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-71]

`Size`

The size of the container.

#### Example [#example-99]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

#### Inherited from [#inherited-from-148]

`PixiContainer.getSize`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-43]

##### event [#event-2]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-72]

`number`

#### Inherited from [#inherited-from-149]

`PixiContainer.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-44]

##### event [#event-3]

`T`

#### Returns [#returns-73]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-150]

`PixiContainer.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-45]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-74]

`this`

#### Inherited from [#inherited-from-151]

`PixiContainer.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-46]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-75]

`this`

#### Inherited from [#inherited-from-152]

`PixiContainer.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-47]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-76]

`this`

#### Inherited from [#inherited-from-153]

`PixiContainer.once`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-48]

##### event? [#event-7]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-77]

`this`

#### Inherited from [#inherited-from-154]

`PixiContainer.removeAllListeners`

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-49]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-78]

`U`\[`0`]

The first child that was removed

#### Example [#example-100]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-32]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-155]

`PixiContainer.removeChild`

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-50]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-79]

`U`

The child that was removed

#### Example [#example-101]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-33]

* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children
* [Container#removeChildren](/pixi-vn/index/classes/Container#removechildren) For removing multiple children

#### Inherited from [#inherited-from-156]

`PixiContainer.removeChildAt`

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-51]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-80]

`ContainerChild`\[]

List of removed children

#### Example [#example-102]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-34]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing specific children

#### Inherited from [#inherited-from-157]

`PixiContainer.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-52]

###### type [#type-2]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-3]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-81]

`void`

##### Inherited from [#inherited-from-158]

`PixiContainer.removeEventListener`

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-53]

###### type [#type-3]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-4]

`RemoveListenerOptions`

##### Returns [#returns-82]

`void`

##### Inherited from [#inherited-from-159]

`PixiContainer.removeEventListener`

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-83]

`void`

#### Example [#example-103]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-35]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a new parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For parent removing children

#### Inherited from [#inherited-from-160]

`PixiContainer.removeFromParent`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-54]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-84]

`this`

#### Inherited from [#inherited-from-161]

`PixiContainer.removeListener`

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-55]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-85]

`U`\[`0`]

The first child that was reparented

#### Example [#example-104]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-36]

* [Container#reparentChildAt](/pixi-vn/index/classes/Container#reparentchildat) For index-specific reparenting
* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For simple parenting

#### Inherited from [#inherited-from-162]

`PixiContainer.reparentChild`

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-56]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-86]

`U`

The reparented child

#### Example [#example-105]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-37]

* [Container#reparentChild](/pixi-vn/index/classes/Container#reparentchild) For appending reparented children
* [Container#addChildAt](/pixi-vn/index/classes/Container#addchildat) For simple indexed parenting

#### Inherited from [#inherited-from-163]

`PixiContainer.reparentChildAt`

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-57]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-87]

`void`

#### Inherited from [#inherited-from-164]

`PixiContainer.replaceChild`

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-58]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-88]

`void`

#### Example [#example-106]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-38]

* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current index
* [Container#swapChildren](/pixi-vn/index/classes/Container#swapchildren) For swapping positions

#### Inherited from [#inherited-from-165]

`PixiContainer.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-59]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-89]

`void`

#### Example [#example-107]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-39]

* [Container#updateTransform](/pixi-vn/index/classes/Container#updatetransform) For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-166]

`PixiContainer.setFromMatrix`

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-60]

##### options [#options-5]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-90]

`void`

#### Example [#example-108]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-40]

* [Container#mask](/pixi-vn/index/classes/VideoSprite#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-167]

`PixiContainer.setMask`

***

### setMemory() [#setmemory]

\> **setMemory**(`_value`): `void` | `Promise`\<`void`>

Defined in: [src/canvas/classes/CanvasBaseItem.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/classes/CanvasBaseItem.ts#L47)

This method set the memory of the canvas element.

#### Parameters [#parameters-61]

##### \_value [#_value]

`T2`

#### Returns [#returns-91]

`void` | `Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Inherited from [#inherited-from-168]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem).[`setMemory`](/pixi-vn/index/classes/CanvasBaseItem#setmemory)

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-62]

##### value [#value-18]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-92]

`void`

#### Example [#example-109]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

#### Inherited from [#inherited-from-169]

`PixiContainer.setSize`

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-63]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-93]

`void`

#### Example [#example-110]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-41]

* [Container#setChildIndex](/pixi-vn/index/classes/Container#setchildindex) For direct index placement
* [Container#getChildIndex](/pixi-vn/index/classes/Container#getchildindex) For getting current positions

#### Inherited from [#inherited-from-170]

`PixiContainer.swapChildren`

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-64]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-1]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-94]

`P`

The global position

#### Example [#example-111]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-42]

* [Container#toLocal](/pixi-vn/index/classes/VideoSprite#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

#### Inherited from [#inherited-from-171]

`PixiContainer.toGlobal`

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-65]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-2]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-95]

`P`

A point object representing the position in local space

#### Example [#example-112]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-43]

* [Container#toGlobal](/pixi-vn/index/classes/VideoSprite#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn/index/classes/VideoSprite#getglobalposition) For container position

#### Inherited from [#inherited-from-172]

`PixiContainer.toLocal`

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-96]

`void`

#### Inherited from [#inherited-from-173]

`PixiContainer.updateLocalTransform`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-66]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-97]

`this`

This container, for chaining

#### Example [#example-113]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-44]

* [Container#setFromMatrix](/pixi-vn/index/classes/Container#setfrommatrix) For matrix-based transforms
* [Container#position](#position) For direct position access

#### Inherited from [#inherited-from-174]

`PixiContainer.updateTransform`


# Interface: CanvasBaseItemMemory (/pixi-vn/index/interfaces/CanvasBaseItemMemory)



Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L6)

Interface for the canvas base memory

## Extended by [#extended-by]

* [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)
* [`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory)
* [`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

## Properties [#properties]

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L16)

***

### parentLabel? [#parentlabel]

\> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

***

### pixivnFilters? [#pixivnfilters]

\> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

***

### pixivnId [#pixivnid]

\> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

***

### zIndex? [#zindex]

\> `optional` **zIndex?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L17)


# Interface: CanvasGameState (/pixi-vn/index/interfaces/CanvasGameState)



Defined in: [src/canvas/interfaces/CanvasGameState.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L6)

Interface exported canvas

## Properties [#properties]

### ~~elementAliasesOrder~~ [#elementaliasesorder]

\> **elementAliasesOrder**: `string`\[]

Defined in: [src/canvas/interfaces/CanvasGameState.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L14)

#### Deprecated [#deprecated]

***

### elements [#elements]

\> **elements**: `object`

Defined in: [src/canvas/interfaces/CanvasGameState.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L9)

#### Index Signature [#index-signature]

\[`alias`: `string`]: [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

***

### stage [#stage]

\> **stage**: `Partial`\<[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)>

Defined in: [src/canvas/interfaces/CanvasGameState.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L10)

***

### tickers [#tickers]

\> **tickers**: `object`

Defined in: [src/canvas/interfaces/CanvasGameState.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L7)

#### Index Signature [#index-signature-1]

\[`id`: `string`]: [`TickerHistory`](/pixi-vn/index/interfaces/TickerHistory)\<`any`>

***

### tickersSteps [#tickerssteps]

\> **tickersSteps**: `object`

Defined in: [src/canvas/interfaces/CanvasGameState.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L8)

#### Index Signature [#index-signature-2]

\[`alias`: `string`]: `object`

***

### tickersToCompleteOnStepEnd [#tickerstocompleteonstepend]

\> **tickersToCompleteOnStepEnd**: `object`

Defined in: [src/canvas/interfaces/CanvasGameState.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasGameState.ts#L15)

#### stepAlias [#stepalias]

\> **stepAlias**: `object`\[]

#### tikersIds [#tikersids]

\> **tikersIds**: `object`\[]


# Interface: CanvasHtmlLayersInterface (/pixi-vn/index/interfaces/CanvasHtmlLayersInterface)



Defined in: [src/canvas/interfaces/CanvasHtmlLayersInterface.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasHtmlLayersInterface.ts#L1)

## Methods [#methods]

### add() [#add]

\> **add**(`id`, `element`, `style?`): `HTMLDivElement`

Defined in: [src/canvas/interfaces/CanvasHtmlLayersInterface.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasHtmlLayersInterface.ts#L23)

Add a HTML layer to the canvas.

#### Parameters [#parameters]

##### id [#id]

`string`

The id of the layer.

##### element [#element]

`HTMLElement`

The html element to be added.

##### style? [#style]

`Partial`\<`Pick`\<`CSSStyleDeclaration`, `"position"` | `"pointerEvents"` | `"userSelect"`>>

The style of the layer.

#### Returns [#returns]

`HTMLDivElement`

#### Default [#default]

```ts
{ position: "absolute", pointerEvents: "none", userSelect: "none" }.
```

#### Example [#example]

```tsx
const root = document.getElementById('root')
if (!root) {
    throw new Error('root element not found')
}
const htmlLayer = canvas.htmlLayers.add("ui", root, {
   position: "absolute",
   pointerEvents: "none"
})
const reactRoot = createRoot(htmlLayer)
reactRoot.render(
    <App />
)
```

***

### get() [#get]

\> **get**(`id`): `HTMLElement` | `undefined`

Defined in: [src/canvas/interfaces/CanvasHtmlLayersInterface.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasHtmlLayersInterface.ts#L32)

Get a HTML layer from the canvas.

#### Parameters [#parameters-1]

##### id [#id-1]

`string`

The id of the layer.

#### Returns [#returns-1]

`HTMLElement` | `undefined`

***

### remove() [#remove]

\> **remove**(`id`): `void`

Defined in: [src/canvas/interfaces/CanvasHtmlLayersInterface.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasHtmlLayersInterface.ts#L37)

Remove a HTML layer from the canvas.

#### Parameters [#parameters-2]

##### id [#id-2]

`string`

The id of the layer to be removed.

#### Returns [#returns-2]

`void`


# Interface: CanvasLayersInterface (/pixi-vn/index/interfaces/CanvasLayersInterface)



Defined in: [src/canvas/interfaces/CanvasLayersInterface.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasLayersInterface.ts#L4)

## Properties [#properties]

### gameLayer [#gamelayer]

\> `readonly` **gameLayer**: `Container`

Defined in: [src/canvas/interfaces/CanvasLayersInterface.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasLayersInterface.ts#L8)

The PIXI Container that contains all the canvas elements.

## Methods [#methods]

### add() [#add]

\> **add**(`label`, `layer`): [`Layer`](/pixi-vn/index/type-aliases/Layer) | `undefined`

Defined in: [src/canvas/interfaces/CanvasLayersInterface.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasLayersInterface.ts#L20)

Add a layer to the canvas.

#### Parameters [#parameters]

##### label [#label]

`string`

The label of the layer.

##### layer [#layer]

`Container`

The layer to be added.

#### Returns [#returns]

[`Layer`](/pixi-vn/index/type-aliases/Layer) | `undefined`

The layer.

#### Example [#example]

```ts
const uiLayer = new Container();
canvas.layers.add("ui", uiLayer);
```

***

### get() [#get]

\> **get**(`label`): [`Layer`](/pixi-vn/index/type-aliases/Layer) | `null`

Defined in: [src/canvas/interfaces/CanvasLayersInterface.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasLayersInterface.ts#L30)

Get a layer from the canvas.

#### Parameters [#parameters-1]

##### label [#label-1]

`string`

The label of the layer.

#### Returns [#returns-1]

[`Layer`](/pixi-vn/index/type-aliases/Layer) | `null`

The layer.

#### Example [#example-1]

```ts
const uiLayer = canvas.layers.get("ui");
```

***

### remove() [#remove]

\> **remove**(`label`): `void`

Defined in: [src/canvas/interfaces/CanvasLayersInterface.ts:39](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasLayersInterface.ts#L39)

Remove a layer from the canvas.

#### Parameters [#parameters-2]

##### label [#label-2]

`string`

The label of the layer to be removed.

#### Returns [#returns-2]

`void`

#### Example [#example-2]

```ts
canvas.layers.remove("ui");
```


# Interface: CanvasManagerInterface (/pixi-vn/index/interfaces/CanvasManagerInterface)



Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L25)

## Properties [#properties]

### app [#app]

\> `readonly` **app**: `Application`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L30)

The PIXI Application instance.
It not recommended to use this property directly.

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L93)

The children of the canvas.

***

### ~~currentTickers~~ [#currenttickers]

\> `readonly` **currentTickers**: `Map`\<`string`, [`TickerInfo`](/pixi-vn/index/interfaces/TickerInfo)\<`any`>>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:217](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L217)

Currently tickers that are running.

#### Deprecated [#deprecated]

Use `tickers.currentTickers` from `@drincs/pixi-vn` instead.

***

### ~~currentTickersSteps~~ [#currenttickerssteps]

\> `readonly` **currentTickersSteps**: `Map`\<`string`, `Map`\<`string`, [`TickersSequence`](/pixi-vn/index/interfaces/TickersSequence)>>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:222](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L222)

The steps of the tickers

#### Deprecated [#deprecated-1]

Use `tickers.currentTickersSteps` from `@drincs/pixi-vn` instead.

***

### ~~gameLayer~~ [#gamelayer]

\> `readonly` **gameLayer**: `Container`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L35)

The PIXI Container that contains all the canvas elements.

#### Deprecated [#deprecated-2]

Use [layers](#layers).gameLayer instead.

***

### height [#height]

\> `readonly` **height**: `number`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:48](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L48)

The height of the canvas.

***

### htmlLayers [#htmllayers]

\> `readonly` **htmlLayers**: [`CanvasHtmlLayersInterface`](/pixi-vn/index/interfaces/CanvasHtmlLayersInterface)

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:509](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L509)

Namespace for operations on canvas HTML layers.

***

### isInitialized [#isinitialized]

\> `readonly` **isInitialized**: `boolean`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:39](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L39)

If the manager is initialized.

***

### layers [#layers]

\> `readonly` **layers**: [`CanvasLayersInterface`](/pixi-vn/index/interfaces/CanvasLayersInterface)

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:505](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L505)

Namespace for operations on canvas layers.

***

### screen [#screen]

\> `readonly` **screen**: `Rectangle`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:52](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L52)

The screen of the canvas (Application.screen).

***

### ~~tickers~~ [#tickers]

\> `readonly` **tickers**: [`CanvasTickersInterface`](/pixi-vn/index/interfaces/CanvasTickersInterface)

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:353](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L353)

Namespace for operations on canvas tickers.

#### Deprecated [#deprecated-3]

Use the top-level `tickers` module (`@drincs/pixi-vn`) instead.

***

### width [#width]

\> `readonly` **width**: `number`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L44)

The width of the canvas.

## Methods [#methods]

### add() [#add]

\> **add**(`alias`, `canvasComponent`, `options?`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:136](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L136)

Add a canvas element to the canvas.
If there is a canvas element with the same alias, all "style", zIndex, and [TickerBase](/pixi-vn/index/classes/TickerBase) will be transferred to the new canvas element,
and the old canvas element will be removed.

#### Parameters [#parameters]

##### alias [#alias]

`string`

The alias to identify the component.

##### canvasComponent [#canvascomponent]

[`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`any`>

The component to add.

##### options? [#options]

The options of the canvas element.

###### ignoreOldStyle? [#ignoreoldstyle]

`boolean`

If there is a canvas element with the same alias, the "style" of the old canvas element will be imported to the new canvas element.

**Default**

```ts
false
```

###### zIndex? [#zindex]

`number`

The zIndex of the canvas element.

**Default**

```ts
undefined
```

#### Returns [#returns]

`void`

#### Example [#example]

```ts
const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
const sprite = Sprite.from(texture);
canvas.add("bunny", sprite);
```

***

### ~~addHtmlLayer()~~ [#addhtmllayer]

\> **addHtmlLayer**(`id`, `element`, `style?`): `HTMLDivElement`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:485](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L485)

Add a HTML layer to the canvas.

#### Parameters [#parameters-1]

##### id [#id]

`string`

The id of the layer.

##### element [#element]

`HTMLElement`

The html element to be added.

##### style? [#style]

`Partial`\<`Pick`\<`CSSStyleDeclaration`, `"position"` | `"pointerEvents"` | `"userSelect"`>>

The style of the layer.

#### Returns [#returns-1]

`HTMLDivElement`

#### Default [#default]

```ts
{ position: "absolute", pointerEvents: "none", userSelect: "none" }.
```

#### Example [#example-1]

```tsx
const root = document.getElementById('root')
if (!root) {
    throw new Error('root element not found')
}
const htmlLayer = canvas.addHtmlLayer("ui", root, {
   position: "absolute",
   pointerEvents: "none"
})
const reactRoot = createRoot(htmlLayer)
reactRoot.render(
    <App />
)
```

#### Deprecated [#deprecated-4]

Use [htmlLayers](#htmllayers).add instead.

***

### ~~addLayer()~~ [#addlayer]

\> **addLayer**(`label`, `layer`): [`Layer`](/pixi-vn/index/type-aliases/Layer) | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:441](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L441)

Add a layer to the canvas.

#### Parameters [#parameters-2]

##### label [#label]

`string`

The label of the layer.

##### layer [#layer]

`Container`

The layer to be added.

#### Returns [#returns-2]

[`Layer`](/pixi-vn/index/type-aliases/Layer) | `undefined`

The layer.

#### Example [#example-2]

```ts
const uiLayer = new Container();
canvas.addLayer("ui", uiLayer);
```

#### Deprecated [#deprecated-5]

Use [layers](#layers).add instead.

***

### ~~addTicker()~~ [#addticker]

\> **addTicker**\<`TArgs`>(`canvasElementAlias`, `ticker`): `string` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:244](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L244)

Run a ticker. You can run multiple addTicker with the same alias and different tickerClasses.
If you run a ticker with the same alias and tickerClass, the old ticker will be removed.
If already exists a sequence of tickers with the same alias, it will be removed.

#### Type Parameters [#type-parameters]

##### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

#### Parameters [#parameters-3]

##### canvasElementAlias [#canvaselementalias]

`string` | `string`\[]

The alias of the canvas element that will use the ticker.

##### ticker [#ticker]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`>

The ticker class to be run.

#### Returns [#returns-3]

`string` | `undefined`

The id of the ticker that was added.

#### Example [#example-3]

```ts
canvas.addTicker("alien", new RotateTicker({ speed: 0.2 }))
```

#### Deprecated [#deprecated-6]

Use `tickers.add` from `@drincs/pixi-vn` instead.

***

### ~~addTickersSequence()~~ [#addtickerssequence]

\> **addTickersSequence**(`alias`, `steps`, `currentStepNumber?`): `string` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:263](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L263)

Run a sequence of tickers.

#### Parameters [#parameters-4]

##### alias [#alias-1]

`string`

The alias of canvas element that will use the tickers.

##### steps [#steps]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>\[]

The steps of the tickers.

##### currentStepNumber? [#currentstepnumber]

`number`

The current step number. It is used to continue the sequence of tickers.

#### Returns [#returns-4]

`string` | `undefined`

The id of tickers.

#### Example [#example-4]

```ts
canvas.addTickersSequence("alien", [
    new RotateTicker({ speed: 0.1, clockwise: true }, 2), // 2 seconds
    new RotateTicker({ speed: 0.2, clockwise: false }, 2),
])
```

#### Deprecated [#deprecated-7]

Use `tickers.addSequence` from `@drincs/pixi-vn` instead.

***

### animate() [#animate]

#### Call Signature [#call-signature]

\> **animate**\<`T`>(`components`, `keyframes`, `options?`, `priority?`): `string` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:402](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L402)

Animate a Pixi’VN component or components using [motion's animate](https://motion.dev/docs/animate) function.
This function integrates with the PixiJS ticker to ensure smooth animations.

Pixi’VN will keep track of the animation state of this function.
So Pixi’VN will save the animation state in saves.

##### Type Parameters [#type-parameters-1]

###### T [#t]

`T` *extends* [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`any`>

The type of Pixi’VN component(s) being animated.

##### Parameters [#parameters-5]

###### components [#components]

`string` | `T` | (`string` | `T`)\[]

The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.

###### keyframes [#keyframes]

`KeyframesType`\<`T`>

This is an object containing the properties to animate and the values to reach.

###### options? [#options-1]

`AnimationOptions`

[`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.

###### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker. This parameter sets the ticker's priority.

##### Returns [#returns-5]

`string` | `undefined`

The function returns the ID of the ticker created to animate the component(s).

##### Default [#default-1]

```ts
UPDATE_PRIORITY.NORMAL
```

#### Call Signature [#call-signature-1]

\> **animate**\<`T`>(`components`, `sequence`, `options?`, `priority?`): `string` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:421](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L421)

Animate a Pixi’VN component or components using [motion's animate](https://motion.dev/docs/animate) function.
This function integrates with the PixiJS ticker to ensure smooth animations.

Pixi’VN will keep track of the animation state of this function.
So Pixi’VN will save the animation state in saves.

##### Type Parameters [#type-parameters-2]

###### T [#t-1]

`T` *extends* [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`any`>

The type of Pixi’VN component(s) being animated.

##### Parameters [#parameters-6]

###### components [#components-1]

`string` | `T`

The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.

###### sequence [#sequence]

(`ObjectSegment`\<`T`> | `ObjectSegmentWithTransition`\<`T`>)\[]

The sequence of keyframes to animate the component(s) with.

###### options? [#options-2]

`SequenceOptions`

[`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.

###### priority? [#priority-1]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker. This parameter sets the ticker's priority.

##### Returns [#returns-6]

`string` | `undefined`

The function returns the ID of the ticker created to animate the component(s).

##### Default [#default-2]

```ts
UPDATE_PRIORITY.NORMAL
```

***

### canvasElementIsOnCanvas() [#canvaselementisoncanvas]

\> **canvasElementIsOnCanvas**\<`T`>(`pixiElement`): `boolean`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:188](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L188)

Check if a DisplayObject is on the canvas.

#### Type Parameters [#type-parameters-3]

##### T [#t-2]

`T` *extends* `Container`\<`ContainerChild`>

#### Parameters [#parameters-7]

##### pixiElement [#pixielement]

`T`

The DisplayObject to be checked.

#### Returns [#returns-7]

`boolean`

If the DisplayObject is on the canvas.

***

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:522](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L522)

Clear the canvas and the tickers.

#### Returns [#returns-8]

`void`

***

### ~~completeTickerOnStepEnd()~~ [#completetickeronstepend]

\> **completeTickerOnStepEnd**(`step`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:371](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L371)

Add a ticker that must be completed before the next step.
This method is used for example into a transition between scenes.

#### Parameters [#parameters-8]

##### step [#step]

The step that the ticker must be completed before the next step.

###### alias? [#alias-2]

`string`

If is a sequence of tickers, the alias of the sequence of tickers.

###### id [#id-1]

`string`

The id of the step.

#### Returns [#returns-9]

`void`

#### Deprecated [#deprecated-8]

Use `tickers.completeOnStepEnd` from `@drincs/pixi-vn` instead.

***

### copyCanvasElementProperty() [#copycanvaselementproperty]

\> **copyCanvasElementProperty**\<`T`>(`oldAlias`, `newAlias`, `options?`): `Promise`\<`void`>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:101](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L101)

Copy the properties of an old canvas element to a new canvas element.

#### Type Parameters [#type-parameters-4]

##### T [#t-3]

`T` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

#### Parameters [#parameters-9]

##### oldAlias [#oldalias]

`string` | `T` | [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`T`>

Old alias

##### newAlias [#newalias]

`string` | [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`T`>

New alias

##### options? [#options-3]

The options of the copy.

###### ignoreProperties? [#ignoreproperties]

(`defaultProperties`) => `string`\[]

If provided, the properties returned by this function will not be copied from the old canvas element to the new canvas element.

#### Returns [#returns-10]

`Promise`\<`void`>

***

### editAlias() [#editalias]

\> **editAlias**(`oldAlias`, `newAlias`, `options?`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:199](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L199)

Edit the alias of a canvas element. The tickers that are connected to the canvas element will be transferred.

#### Parameters [#parameters-10]

##### oldAlias [#oldalias-1]

`string`

The old alias of the component to edit.

##### newAlias [#newalias-1]

`string`

The new alias of the component.

##### options? [#options-4]

The options of the canvas element.

###### ignoreTickers? [#ignoretickers]

`boolean`

If true, the tickers that are connected to the canvas element will not be transferred.

**Default**

```ts
false
```

#### Returns [#returns-11]

`void`

***

### export() [#export]

\> **export**(): [`CanvasGameState`](/pixi-vn/index/interfaces/CanvasGameState)

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:530](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L530)

Export the canvas and the tickers to an object.

#### Returns [#returns-12]

[`CanvasGameState`](/pixi-vn/index/interfaces/CanvasGameState)

The object.

***

### extractImage() [#extractimage]

\> **extractImage**(): `Promise`\<`string`>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:517](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L517)

Extract the canvas as an image.

#### Returns [#returns-13]

`Promise`\<`string`>

The image as a base64 string.

***

### find() [#find]

\> **find**\<`T`>(`alias`): `T` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:182](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L182)

Get a canvas element by the alias.

#### Type Parameters [#type-parameters-5]

##### T [#t-4]

`T` *extends* [`CanvasBaseInterface`](/pixi-vn/index/interfaces/CanvasBaseInterface)\<`any`>

#### Parameters [#parameters-11]

##### alias [#alias-3]

`string`

The alias to identify the component.

#### Returns [#returns-14]

`T` | `undefined`

The canvas element. If the component does not exist, it will return `undefined`.

#### Example [#example-5]

```ts
const sprite = canvas.find<Sprite>("bunny");
```

***

### ~~findTicker()~~ [#findticker]

\> **findTicker**\<`TArgs`>(`tickerId`, `args?`): [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:230](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L230)

Find a ticker by its id.

#### Type Parameters [#type-parameters-6]

##### TArgs [#targs-1]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

#### Parameters [#parameters-12]

##### tickerId [#tickerid]

`string`

The id of the ticker to be found.

##### args? [#args]

`TArgs`

The args of the ticker.

#### Returns [#returns-15]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

The ticker if found, undefined otherwise.

#### Deprecated [#deprecated-9]

Use `tickers.find` from `@drincs/pixi-vn` instead.

***

### ~~forceCompletionOfTicker()~~ [#forcecompletionofticker]

\> **forceCompletionOfTicker**(`id`, `alias?`): `Promise`\<`void`>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:388](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L388)

This method force the completion of the tickers that are running.
This funcions is called in the next step.

#### Parameters [#parameters-13]

##### id [#id-2]

`string`

The id of the ticker. If the alias provided, the id is the id of the sequence of tickers.

##### alias? [#alias-4]

`string`

The alias of the sequence of tickers.

#### Returns [#returns-16]

`Promise`\<`void`>

#### Deprecated [#deprecated-10]

Use `tickers.forceCompletion` from `@drincs/pixi-vn` instead.

***

### ~~getHtmlLayer()~~ [#gethtmllayer]

\> **getHtmlLayer**(`id`): `HTMLElement` | `undefined`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:501](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L501)

Get a HTML layer from the canvas.

#### Parameters [#parameters-14]

##### id [#id-3]

`string`

The id of the layer.

#### Returns [#returns-17]

`HTMLElement` | `undefined`

#### Deprecated [#deprecated-11]

Use [htmlLayers](#htmllayers).get instead.

***

### ~~getLayer()~~ [#getlayer]

\> **getLayer**(`label`): [`Layer`](/pixi-vn/index/type-aliases/Layer) | `null`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:452](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L452)

Get a layer from the canvas.

#### Parameters [#parameters-15]

##### label [#label-1]

`string`

The label of the layer.

#### Returns [#returns-18]

[`Layer`](/pixi-vn/index/type-aliases/Layer) | `null`

The layer.

#### Example [#example-6]

```ts
const uiLayer = canvas.getLayer("ui");
```

#### Deprecated [#deprecated-12]

Use [layers](#layers).get instead.

***

### init() [#init]

\> **init**(`element`, `options`, `devtoolsOptions?`): `Promise`\<`void`>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L74)

Initialize the PixiJS Application and the interface div.
This method should be called before any other method.

#### Parameters [#parameters-16]

##### element [#element-1]

`HTMLElement`

The html element where I will put the canvas. Example: document.body

##### options [#options-5]

`Partial`\<[`ApplicationOptions`](/pixi-vn/index/interfaces/ApplicationOptions)> & `object`

The options of PixiJS Application

##### devtoolsOptions? [#devtoolsoptions]

`Devtools`

The options of the devtools. You can read more about it in the [PixiJS Devtools documentation](https://pixijs.io/devtools/docs/plugin/)

#### Returns [#returns-19]

`Promise`\<`void`>

#### Example [#example-7]

```ts
const body = document.body
if (!body) {
    throw new Error('body element not found')
}
await canvas.init(body, {
    width: 1920,
    height: 1080,
    backgroundColor: "#303030"
})
```

***

### ~~isTickerPaused()~~ [#istickerpaused]

\> **isTickerPaused**(`alias`, `tickerId?`): `boolean`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:348](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L348)

#### Parameters [#parameters-17]

##### alias [#alias-5]

`string`

The alias of the canvas element that will use the ticker.

##### tickerId? [#tickerid-1]

`string`

The ticker that will be checked.

#### Returns [#returns-20]

`boolean`

If the ticker is paused.

#### Deprecated [#deprecated-13]

Use `tickers.isPaused` from `@drincs/pixi-vn` instead.
Check if a ticker is paused.

***

### ~~onTickerComplete()~~ [#ontickercomplete]

\> **onTickerComplete**(`tickerId`, `options`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:539](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L539)

#### Parameters [#parameters-18]

##### tickerId [#tickerid-2]

`string`

##### options [#options-6]

###### aliasToRemoveAfter [#aliastoremoveafter]

`string`\[]

###### ignoreTickerSteps? [#ignoretickersteps]

`boolean`

###### stopTicker? [#stopticker]

`boolean`

###### tickerAliasToResume [#tickeraliastoresume]

`string`\[]

###### tickerIdToResume [#tickeridtoresume]

`string`\[]

#### Returns [#returns-21]

`void`

#### Deprecated [#deprecated-14]

Use `tickers.onComplete` from `@drincs/pixi-vn` instead.

***

### pause() [#pause]

\> **pause**(): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:359](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L359)

Pause the rendering of gameLayer and pause currently running tickers.
Use [resume](#resume) to restore rendering and resume only
the tickers paused by this method.

#### Returns [#returns-22]

`void`

***

### ~~pauseTicker()~~ [#pauseticker]

\> **pauseTicker**(`filters`): `string`\[]

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:300](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L300)

Pause a ticker. If a paused ticker have a time to be removed, it will be removed after the time.

#### Parameters [#parameters-19]

##### filters [#filters]

\{ `canvasAlias`: `string`; `tickerIdsExcluded?`: `string`\[]; } | \{ `id`: `string` | `string`\[]; }

The filters to pause the ticker.

###### Type Literal [#type-literal]

\{ `canvasAlias`: `string`; `tickerIdsExcluded?`: `string`\[]; }

The filters to pause the ticker.

###### canvasAlias [#canvasalias]

`string`

The alias of the canvas element that will use the ticker.
Will pause all tickers that are connected to this canvas element.

###### tickerIdsExcluded? [#tickeridsexcluded]

`string`\[]

Ticker ids excluded from the pause. If not provided, all tickers will be paused.

***

###### Type Literal [#type-literal-1]

\{ `id`: `string` | `string`\[]; }

The filters to pause the ticker.

###### id [#id-4]

`string` | `string`\[]

The id of the ticker to be paused. If provided, only this ticker will be paused.

#### Returns [#returns-23]

`string`\[]

The ids of the paused tickers.

#### Deprecated [#deprecated-15]

Use `tickers.pause` from `@drincs/pixi-vn` instead.

***

### remove() [#remove]

\> **remove**(`alias`, `options?`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:163](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L163)

Remove a canvas element from the canvas.
And remove all tickers that are not connected to any canvas element.

#### Parameters [#parameters-20]

##### alias [#alias-6]

`string` | `string`\[]

The alias of the canvas element to be removed.

##### options? [#options-7]

The options of the canvas element.

###### ignoreTickers? [#ignoretickers-1]

`boolean`

If true, the tickers that are connected to the canvas element will not be removed.

**Default**

```ts
false
```

#### Returns [#returns-24]

`void`

#### Example [#example-8]

```ts
canvas.remove("bunny");
```

***

### removeAll() [#removeall]

\> **removeAll**(): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:192](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L192)

Remove all canvas elements from the canvas.

#### Returns [#returns-25]

`void`

***

### ~~removeAllTickers()~~ [#removealltickers]

\> **removeAllTickers**(): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:287](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L287)

Remove all tickers from the canvas.

#### Returns [#returns-26]

`void`

#### Deprecated [#deprecated-16]

Use `tickers.removeAll` from `@drincs/pixi-vn` instead.

***

### ~~removeHtmlLayer()~~ [#removehtmllayer]

\> **removeHtmlLayer**(`id`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:495](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L495)

Get a HTML layer from the canvas.

#### Parameters [#parameters-21]

##### id [#id-5]

`string`

The id of the layer to be removed.

#### Returns [#returns-27]

`void`

#### Deprecated [#deprecated-17]

Use [htmlLayers](#htmllayers).remove instead.

***

### ~~removeLayer()~~ [#removelayer]

\> **removeLayer**(`label`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:462](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L462)

Remove a layer from the canvas.

#### Parameters [#parameters-22]

##### label [#label-2]

`string`

The label of the layer to be removed.

#### Returns [#returns-28]

`void`

#### Example [#example-9]

```ts
canvas.removeLayer("ui");
```

#### Deprecated [#deprecated-18]

Use [layers](#layers).remove instead.

***

### ~~removeTicker()~~ [#removeticker]

\> **removeTicker**(`tickerId`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:293](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L293)

Remove a ticker by the id.

#### Parameters [#parameters-23]

##### tickerId [#tickerid-3]

`string` | `string`\[]

The id or an array of ids of the ticker to be removed.

#### Returns [#returns-29]

`void`

#### Deprecated [#deprecated-19]

Use `tickers.remove` from `@drincs/pixi-vn` instead.

***

### restore() [#restore]

\> **restore**(`data`): `Promise`\<`void`>

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:535](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L535)

Restore the canvas and the tickers from an object.

#### Parameters [#parameters-24]

##### data [#data]

`object`

The object.

#### Returns [#returns-30]

`Promise`\<`void`>

***

### resume() [#resume]

\> **resume**(): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:364](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L364)

Resume the rendering of gameLayer and resume tickers that were paused by
[pause](#pause).

#### Returns [#returns-31]

`void`

***

### ~~resumeTicker()~~ [#resumeticker]

\> **resumeTicker**(`filters`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:325](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L325)

Resume a ticker.

#### Parameters [#parameters-25]

##### filters [#filters-1]

\{ `canvasAlias`: `string`; } | \{ `id`: `string` | `string`\[]; }

The filters to resume the ticker.

###### Type Literal [#type-literal-2]

\{ `canvasAlias`: `string`; }

The filters to resume the ticker.

###### canvasAlias [#canvasalias-1]

`string`

The alias of the canvas element that will use the ticker.
Will resume all tickers that are connected to this canvas element.

***

###### Type Literal [#type-literal-3]

\{ `id`: `string` | `string`\[]; }

The filters to resume the ticker.

###### id [#id-6]

`string` | `string`\[]

The id of the ticker to be resumed. If provided, only this ticker will be resumed.

#### Returns [#returns-32]

`void`

#### Deprecated [#deprecated-20]

Use `tickers.resume` from `@drincs/pixi-vn` instead.

***

### ~~transferTickers()~~ [#transfertickers]

\> **transferTickers**(`oldAlias`, `newAlias`, `mode?`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:121](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L121)

Transfer the tickers from an old alias to a new alias.

#### Parameters [#parameters-26]

##### oldAlias [#oldalias-2]

`string`

Old alias

##### newAlias [#newalias-2]

`string`

New alias

##### mode? [#mode]

`"move"` | `"duplicate"`

If "move", the old alias will be removed from the ticker. If "duplicate", the old alias will be kept in the ticker.

#### Returns [#returns-33]

`void`

#### Deprecated [#deprecated-21]

Use `tickers.transfer` from `@drincs/pixi-vn` instead.

***

### ~~unlinkComponentFromTicker()~~ [#unlinkcomponentfromticker]

\> **unlinkComponentFromTicker**(`alias`, `ticker?`): `void`

Defined in: [src/canvas/interfaces/CanvasManagerInterface.ts:279](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/CanvasManagerInterface.ts#L279)

Remove a connection between a canvas element and a ticker.
And remove the ticker if there is no canvas element connected to it.

#### Parameters [#parameters-27]

##### alias [#alias-7]

`string` | `string`\[]

The alias of the canvas element that will use the ticker.

##### ticker? [#ticker-1]

`string` | (() => [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>)

The ticker class to be removed.

#### Returns [#returns-34]

`void`

#### Example [#example-10]

```ts
canvas.unlinkComponentFromTicker("alien", RotateTicker)
```

#### Deprecated [#deprecated-22]

Use `tickers.unlinkComponent` from `@drincs/pixi-vn` instead.


# Interface: CanvasTickersInterface (deprecated) (/pixi-vn/index/interfaces/CanvasTickersInterface)



Defined in: [src/tickers/interfaces/TickersInterface.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L6)

## Deprecated [#deprecated]

Use `TickersInterface` from `@drincs/pixi-vn` instead.

## Properties [#properties]

### ~~currentTickers~~ [#currenttickers]

\> `readonly` **currentTickers**: `Map`\<`string`, [`TickerInfo`](/pixi-vn/index/interfaces/TickerInfo)\<`any`>>

Defined in: [src/tickers/interfaces/TickersInterface.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L17)

Currently tickers that are running.

***

### ~~currentTickersSteps~~ [#currenttickerssteps]

\> `readonly` **currentTickersSteps**: `Map`\<`string`, `Map`\<`string`, [`TickersSequence`](/pixi-vn/index/interfaces/TickersSequence)>>

Defined in: [src/tickers/interfaces/TickersInterface.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L21)

The steps of the tickers

## Methods [#methods]

### ~~add()~~ [#add]

\> **add**\<`TArgs`>(`canvasElementAlias`, `ticker`): `string` | `undefined`

Defined in: [src/tickers/interfaces/TickersInterface.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L41)

Run a ticker. You can run multiple add with the same alias and different tickerClasses.
If you run a ticker with the same alias and tickerClass, the old ticker will be removed.
If already exists a sequence of tickers with the same alias, it will be removed.

#### Type Parameters [#type-parameters]

##### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

#### Parameters [#parameters]

##### canvasElementAlias [#canvaselementalias]

`string` | `string`\[]

The alias of the canvas element that will use the ticker.

##### ticker [#ticker]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`>

The ticker class to be run.

#### Returns [#returns]

`string` | `undefined`

The id of the ticker that was added.

#### Example [#example]

```ts
tickers.add("alien", new RotateTicker({ speed: 0.2 }))
```

***

### ~~addSequence()~~ [#addsequence]

\> **addSequence**(`alias`, `steps`, `currentStepNumber?`): `string` | `undefined`

Defined in: [src/tickers/interfaces/TickersInterface.ts:60](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L60)

Run a sequence of tickers.

#### Parameters [#parameters-1]

##### alias [#alias]

`string`

The alias of canvas element that will use the tickers.

##### steps [#steps]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>\[]

The steps of the tickers.

##### currentStepNumber? [#currentstepnumber]

`number`

The current step number. It is used to continue the sequence of tickers.

#### Returns [#returns-1]

`string` | `undefined`

The id of tickers.

#### Example [#example-1]

```ts
tickers.addSequence("alien", [
    new RotateTicker({ speed: 0.1, clockwise: true }, 2), // runs for 2 seconds
    new RotateTicker({ speed: 0.2, clockwise: false }, 2),
])
```

#### Deprecated [#deprecated-1]

***

### ~~completeOnStepEnd()~~ [#completeonstepend]

\> **completeOnStepEnd**(`step`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:142](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L142)

Add a ticker that must be completed before the next step.
This method is used for example into a transition between scenes.

#### Parameters [#parameters-2]

##### step [#step]

The step that the ticker must be completed before the next step.

###### alias? [#alias-1]

`string`

If is a sequence of tickers, the alias of the sequence of tickers.

###### id [#id]

`string`

The id of the step.

#### Returns [#returns-2]

`void`

***

### ~~find()~~ [#find]

\> **find**\<`TArgs`>(`tickerId`, `args?`): [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

Defined in: [src/tickers/interfaces/TickersInterface.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L28)

Find a ticker by its id.

#### Type Parameters [#type-parameters-1]

##### TArgs [#targs-1]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

#### Parameters [#parameters-3]

##### tickerId [#tickerid]

`string`

The id of the ticker to be found.

##### args? [#args]

`TArgs`

The args of the ticker.

#### Returns [#returns-3]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

The ticker if found, undefined otherwise.

***

### ~~forceCompletion()~~ [#forcecompletion]

\> **forceCompletion**(`id`, `alias?`): `Promise`\<`void`>

Defined in: [src/tickers/interfaces/TickersInterface.ts:158](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L158)

This method force the completion of the tickers that are running.
This funcions is called in the next step.

#### Parameters [#parameters-4]

##### id [#id-1]

`string`

The id of the ticker. If the alias provided, the id is the id of the sequence of tickers.

##### alias? [#alias-2]

`string`

The alias of the sequence of tickers.

#### Returns [#returns-4]

`Promise`\<`void`>

***

### ~~isPaused()~~ [#ispaused]

\> **isPaused**(`alias`, `tickerId?`): `boolean`

Defined in: [src/tickers/interfaces/TickersInterface.ts:136](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L136)

Check if a ticker is paused.

#### Parameters [#parameters-5]

##### alias [#alias-3]

`string`

The alias of the canvas element that will use the ticker.

##### tickerId? [#tickerid-1]

`string`

The ticker that will be checked.

#### Returns [#returns-5]

`boolean`

If the ticker is paused.

***

### ~~onComplete()~~ [#oncomplete]

\> **onComplete**(`tickerId`, `options`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:159](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L159)

#### Parameters [#parameters-6]

##### tickerId [#tickerid-2]

`string`

##### options [#options]

###### aliasToRemoveAfter [#aliastoremoveafter]

`string`\[]

###### ignoreTickerSteps? [#ignoretickersteps]

`boolean`

###### stopTicker? [#stopticker]

`boolean`

###### tickerAliasToResume [#tickeraliastoresume]

`string`\[]

###### tickerIdToResume [#tickeridtoresume]

`string`\[]

#### Returns [#returns-6]

`void`

***

### ~~pause()~~ [#pause]

\> **pause**(`filters`): `string`\[]

Defined in: [src/tickers/interfaces/TickersInterface.ts:90](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L90)

Pause a ticker. If a paused ticker have a time to be removed, it will be removed after the time.

#### Parameters [#parameters-7]

##### filters [#filters]

\{ `canvasAlias`: `string`; `tickerIdsExcluded?`: `string`\[]; } | \{ `id`: `string` | `string`\[]; }

The filters to pause the ticker.

###### Type Literal [#type-literal]

\{ `canvasAlias`: `string`; `tickerIdsExcluded?`: `string`\[]; }

The filters to pause the ticker.

###### canvasAlias [#canvasalias]

`string`

The alias of the canvas element that will use the ticker.
Will pause all tickers that are connected to this canvas element.

###### tickerIdsExcluded? [#tickeridsexcluded]

`string`\[]

Ticker ids excluded from the pause. If not provided, all tickers will be paused.

***

###### Type Literal [#type-literal-1]

\{ `id`: `string` | `string`\[]; }

The filters to pause the ticker.

###### id [#id-2]

`string` | `string`\[]

The id of the ticker to be paused. If provided, only this ticker will be paused.

#### Returns [#returns-7]

`string`\[]

The ids of the paused tickers.

***

### ~~remove()~~ [#remove]

\> **remove**(`tickerId`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:84](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L84)

Remove a ticker by the id.

#### Parameters [#parameters-8]

##### tickerId [#tickerid-3]

`string` | `string`\[]

The id or an array of ids of the ticker to be removed.

#### Returns [#returns-8]

`void`

***

### ~~removeAll()~~ [#removeall]

\> **removeAll**(): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:79](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L79)

Remove all tickers from the canvas.

#### Returns [#returns-9]

`void`

***

### ~~resume()~~ [#resume]

\> **resume**(`filters`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:114](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L114)

Resume a ticker.

#### Parameters [#parameters-9]

##### filters [#filters-1]

\{ `canvasAlias`: `string`; } | \{ `id`: `string` | `string`\[]; }

The filters to resume the ticker.

###### Type Literal [#type-literal-2]

\{ `canvasAlias`: `string`; }

The filters to resume the ticker.

###### canvasAlias [#canvasalias-1]

`string`

The alias of the canvas element that will use the ticker.
Will resume all tickers that are connected to this canvas element.

***

###### Type Literal [#type-literal-3]

\{ `id`: `string` | `string`\[]; }

The filters to resume the ticker.

###### id [#id-3]

`string` | `string`\[]

The id of the ticker to be resumed. If provided, only this ticker will be resumed.

#### Returns [#returns-10]

`void`

***

### ~~transfer()~~ [#transfer]

\> **transfer**(`oldAlias`, `newAlias`, `mode?`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L13)

Transfer the tickers from an old alias to a new alias.

#### Parameters [#parameters-10]

##### oldAlias [#oldalias]

`string`

Old alias

##### newAlias [#newalias]

`string`

New alias

##### mode? [#mode]

`"move"` | `"duplicate"`

If "move", the old alias will be removed from the ticker. If "duplicate", the old alias will be kept in the ticker.

#### Returns [#returns-11]

`void`

***

### ~~unlinkComponent()~~ [#unlinkcomponent]

\> **unlinkComponent**(`alias`, `ticker?`): `void`

Defined in: [src/tickers/interfaces/TickersInterface.ts:75](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersInterface.ts#L75)

Remove a connection between a canvas element and a ticker.
And remove the ticker if there is no canvas element connected to it.

#### Parameters [#parameters-11]

##### alias [#alias-4]

`string` | `string`\[]

The alias of the canvas element that will use the ticker.

##### ticker? [#ticker-1]

`string` | (() => [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>)

The ticker class to be removed.

#### Returns [#returns-12]

`void`

#### Example [#example-2]

```ts
tickers.unlinkComponent("alien", RotateTicker)
```


# Interface: ChannelOptions (/pixi-vn/index/interfaces/ChannelOptions)



Defined in: [src/sound/interfaces/SoundOptions.ts:67](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L67)

## Extends [#extends]

* `Pick`\<[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions), `"filters"` | `"muted"` | `"volume"`>

## Properties [#properties]

### background? [#background]

\> `optional` **background?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:73](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L73)

Whether this channel is a background channel.
Background channels are special: media playing on them is not stopped
when a scene changes, but continues in the background.

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L34)

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

#### Inherited from [#inherited-from]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`filters`](/pixi-vn/index/interfaces/SoundOptions#filters)

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L42)

#### Deprecated [#deprecated]

Use [mute](/pixi-vn/index/interfaces/SoundOptions#mute) instead.

#### Inherited from [#inherited-from-1]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`muted`](/pixi-vn/index/interfaces/SoundOptions#muted)

***

### pan? [#pan]

\> `optional` **pan?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:79](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L79)

The stereo pan position for this channel in the range \[-1, 1].
-1 is full left, 0 is centre, 1 is full right.
Defaults to 0.

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L21)

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-2]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`volume`](/pixi-vn/index/interfaces/SoundOptions#volume)


# Interface: CharacterEmotionId (/pixi-vn/index/interfaces/CharacterEmotionId)



Defined in: [src/characters/types/CharacterEmotionId.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/types/CharacterEmotionId.ts#L6)

CharacterEmotionId is used to identify a character together with an emotion.

## Properties [#properties]

### emotion [#emotion]

\> **emotion**: `string`

Defined in: [src/characters/types/CharacterEmotionId.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/types/CharacterEmotionId.ts#L8)

***

### id [#id]

\> **id**: `string`

Defined in: [src/characters/types/CharacterEmotionId.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/types/CharacterEmotionId.ts#L7)


# Interface: CharacterInterface (/pixi-vn/index/interfaces/CharacterInterface)



Defined in: [src/characters/interfaces/CharacterInterface.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/interfaces/CharacterInterface.ts#L56)

CharacterInterface is the interface that character must implement or extend.
So if you want to create your own Character, you must override this interface, implement or extend it and extend the [CharacterStoredClass](/pixi-vn/index/classes/CharacterStoredClass) class.
You can override this interface to add your own props.

## Example [#example]

```ts
// pixi-vn.d.ts
declare module '@drincs/pixi-vn' {
    interface CharacterInterface {
        name: string
        surname?: string
        age?: number
        icon?: string
        color?: string
    }
}
// You Character class
export class Character extends CharacterStoredClass implements CharacterInterface {
    constructor(id: string, props: CharacterProps) {
        super(id)
        this.defaultName = props.name
        this.defaultSurname = props.surname
        this.defaultAge = props.age
        this.icon = props.icon
        this.color = props.color
    }
    readonly defaultName: string = ""
    get name(): string {
        return this.getStorageProperty<string>("name") || this.defaultName
    }
    set name(value: string | undefined) {
        this.setStorageProperty("name", value)
    }
    readonly defaultSurname?: string
    get surname(): string | undefined {
        return this.getStorageProperty<string>("surname") || this.defaultSurname
    }
    set surname(value: string | undefined) {
        this.setStorageProperty("surname", value)
    }
    readonly defaultAge?: number | undefined
    get age(): number | undefined {
        return this.getStorageProperty<number>("age") || this.defaultAge
    }
    set age(value: number | undefined) {
        this.setStorageProperty("age", value)
    }
    readonly icon?: string
    get icon(): string | undefined {
        return this._icon
    }
    readonly color?: string | undefined
}
```

## Properties [#properties]

### id [#id]

\> **id**: `string`

Defined in: [src/characters/interfaces/CharacterInterface.ts:60](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/interfaces/CharacterInterface.ts#L60)

The id of the character. It must be unique.


# Interface: ChoiceInterface (/pixi-vn/index/interfaces/ChoiceInterface)



Defined in: [src/narration/interfaces/ChoiceInterface.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L6)

## Properties [#properties]

### autoSelect? [#autoselect]

\> `optional` **autoSelect?**: `boolean`

Defined in: [src/narration/interfaces/ChoiceInterface.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L30)

If this is true and if is the only choice, it will be automatically selected, and call/jump to the label.

***

### closeCurrentLabel? [#closecurrentlabel]

\> `optional` **closeCurrentLabel?**: `boolean`

Defined in: [src/narration/interfaces/ChoiceInterface.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L34)

If true, the current label will be closed

***

### label [#label]

\> **label**: `string`

Defined in: [src/narration/interfaces/ChoiceInterface.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L14)

Label Id to be opened when the option is selected

***

### oneTime? [#onetime]

\> `optional` **oneTime?**: `boolean`

Defined in: [src/narration/interfaces/ChoiceInterface.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L22)

If this is true, the choice can only be made once.

***

### onlyHaveNoChoice? [#onlyhavenochoice]

\> `optional` **onlyHaveNoChoice?**: `boolean`

Defined in: [src/narration/interfaces/ChoiceInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L26)

If this is true, the choice can see only if there are no other choices. For example, all choices are one-time choices and they are already selected.

***

### props? [#props]

\> `optional` **props?**: [`StorageObjectType`](/pixi-vn/index/type-aliases/StorageObjectType)

Defined in: [src/narration/interfaces/ChoiceInterface.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L38)

Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.

***

### text [#text]

\> **text**: `string` | `string`\[]

Defined in: [src/narration/interfaces/ChoiceInterface.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L10)

Text to be displayed in the menu

***

### type [#type]

\> **type**: `"close"` | [`LabelRunModeType`](/pixi-vn/index/type-aliases/LabelRunModeType)

Defined in: [src/narration/interfaces/ChoiceInterface.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/ChoiceInterface.ts#L18)

Type of the label to be opened


# Interface: ChoiceOptionInterface (/pixi-vn/index/interfaces/ChoiceOptionInterface)



Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L6)

## Extends [#extends]

* `Omit`\<`ChoiceInterface`, `"label"` | `"type"` | `"closeCurrentLabel"`>

## Properties [#properties]

### autoSelect? [#autoselect]

\> `optional` **autoSelect?**: `boolean`

Defined in: [src/pixi-vn.d.ts:66](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L66)

If `true` and it is the only choice, it will be selected automatically.

#### Inherited from [#inherited-from]

`Omit.autoSelect`

***

### label [#label]

\> **label**: `string`

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L11)

Label Id to be opened when the option is selected

***

### oneTime? [#onetime]

\> `optional` **oneTime?**: `boolean`

Defined in: [src/pixi-vn.d.ts:57](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L57)

If `true`, the choice can only be made once.

#### Inherited from [#inherited-from-1]

`Omit.oneTime`

***

### onlyHaveNoChoice? [#onlyhavenochoice]

\> `optional` **onlyHaveNoChoice?**: `boolean`

Defined in: [src/pixi-vn.d.ts:62](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L62)

If `true`, the choice is shown only if there are no other choices.
For example, all choices are one-time choices and they are already selected.

#### Inherited from [#inherited-from-2]

`Omit.onlyHaveNoChoice`

***

### props? [#props]

\> `optional` **props?**: `any`

Defined in: [src/pixi-vn.d.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L74)

Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.

#### Inherited from [#inherited-from-3]

`Omit.props`

***

### text [#text]

\> **text**: `string` | `string`\[]

Defined in: [src/pixi-vn.d.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L45)

Text to be displayed in the menu

#### Inherited from [#inherited-from-4]

`Omit.text`

***

### type [#type]

\> **type**: [`LabelRunModeType`](/pixi-vn/index/type-aliases/LabelRunModeType)

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L15)

Type of the label to be opened


# Interface: ChromaticAberrationEffectProps (/pixi-vn/index/interfaces/ChromaticAberrationEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:192](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L192)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### axis? [#axis]

\> `optional` **axis?**: `"horizontal"` | `"vertical"`

Defined in: [src/canvas/interfaces/effect-props.ts:203](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L203)

The axis the channels split along.

#### Default [#default-1]

```ts
"horizontal"
```

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### bursts? [#bursts]

\> `optional` **bursts?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:208](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L208)

The number of bursts.

#### Default [#default-2]

```ts
1
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-3]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-4]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-5]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:198](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L198)

The peak red/blue channel pixel offset of the first, largest burst (channels split in opposite
directions, green stays centered).

#### Default [#default-8]

```ts
8
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: CloseChoiceOptionInterface (/pixi-vn/index/interfaces/CloseChoiceOptionInterface)



Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L18)

## Extends [#extends]

* `Omit`\<`ChoiceInterface`, `"label"` | `"type"` | `"closeCurrentLabel"`>

## Properties [#properties]

### autoSelect? [#autoselect]

\> `optional` **autoSelect?**: `boolean`

Defined in: [src/pixi-vn.d.ts:66](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L66)

If `true` and it is the only choice, it will be selected automatically.

#### Inherited from [#inherited-from]

`Omit.autoSelect`

***

### closeCurrentLabel? [#closecurrentlabel]

\> `optional` **closeCurrentLabel?**: `boolean`

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L27)

If true, the current label will be closed

***

### oneTime? [#onetime]

\> `optional` **oneTime?**: `boolean`

Defined in: [src/pixi-vn.d.ts:57](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L57)

If `true`, the choice can only be made once.

#### Inherited from [#inherited-from-1]

`Omit.oneTime`

***

### onlyHaveNoChoice? [#onlyhavenochoice]

\> `optional` **onlyHaveNoChoice?**: `boolean`

Defined in: [src/pixi-vn.d.ts:62](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L62)

If `true`, the choice is shown only if there are no other choices.
For example, all choices are one-time choices and they are already selected.

#### Inherited from [#inherited-from-2]

`Omit.onlyHaveNoChoice`

***

### props? [#props]

\> `optional` **props?**: `any`

Defined in: [src/pixi-vn.d.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L74)

Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.

#### Inherited from [#inherited-from-3]

`Omit.props`

***

### text [#text]

\> **text**: `string` | `string`\[]

Defined in: [src/pixi-vn.d.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/pixi-vn.d.ts#L45)

Text to be displayed in the menu

#### Inherited from [#inherited-from-4]

`Omit.text`

***

### type [#type]

\> **type**: `"close"`

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L23)

Type of the label to be opened


# Interface: ContainerMemory<C> (/pixi-vn/index/interfaces/ContainerMemory)



Defined in: [src/canvas/interfaces/memory/ContainerMemory.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ContainerMemory.ts#L10)

Interface for the canvas container memory

## Extends [#extends]

* `ContainerOptions`\<`C`>.[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory).[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Extended by [#extended-by]

* [`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory)

## Type Parameters [#type-parameters]

### C [#c]

`C` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild) = [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`ContainerOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`ContainerOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`ContainerOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`ContainerOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`ContainerOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`ContainerOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`ContainerOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

`ContainerOptions.alpha`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-9]

`ContainerOptions.angle`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-10]

`ContainerOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-11]

`ContainerOptions.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-12]

`ContainerOptions.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-13]

`ContainerOptions.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-14]

`ContainerOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-15]

`ContainerOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-16]

`ContainerOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-17]

`ContainerOptions.cursor`

***

### elements [#elements]

\> **elements**: [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)\[]

Defined in: [src/canvas/interfaces/memory/ContainerMemory.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ContainerMemory.ts#L18)

The elements contained in this container

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-18]

`ContainerOptions.eventMode`

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-19]

`ContainerOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-20]

`ContainerOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-21]

`ContainerOptions.hitArea`

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-22]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`index`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

`ContainerOptions.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

`ContainerOptions.interactiveChildren`

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

`ContainerOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`label`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`ContainerOptions.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

`ContainerOptions.onclick`

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-28]

[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory).[`onEvents`](/pixi-vn/index/interfaces/ListenerExtensionMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

`ContainerOptions.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

`ContainerOptions.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

`ContainerOptions.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-32]

`ContainerOptions.onmousedown`

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-33]

`ContainerOptions.onmouseenter`

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-34]

`ContainerOptions.onmouseleave`

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-35]

`ContainerOptions.onmousemove`

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-36]

`ContainerOptions.onmouseout`

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-37]

`ContainerOptions.onmouseover`

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-38]

`ContainerOptions.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-39]

`ContainerOptions.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-40]

`ContainerOptions.onpointercancel`

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-41]

`ContainerOptions.onpointerdown`

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-42]

`ContainerOptions.onpointerenter`

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-43]

`ContainerOptions.onpointerleave`

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-44]

`ContainerOptions.onpointermove`

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-45]

`ContainerOptions.onpointerout`

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-46]

`ContainerOptions.onpointerover`

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-47]

`ContainerOptions.onpointertap`

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-48]

`ContainerOptions.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-49]

`ContainerOptions.onpointerupoutside`

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

`ContainerOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

`ContainerOptions.onrightclick`

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-52]

`ContainerOptions.onrightdown`

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-53]

`ContainerOptions.onrightup`

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-54]

`ContainerOptions.onrightupoutside`

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-55]

`ContainerOptions.ontap`

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-56]

`ContainerOptions.ontouchcancel`

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-57]

`ContainerOptions.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-58]

`ContainerOptions.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-59]

`ContainerOptions.ontouchmove`

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-60]

`ContainerOptions.ontouchstart`

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-61]

`ContainerOptions.onwheel`

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

`ContainerOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-63]

`ContainerOptions.parent`

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-64]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`parentLabel`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-68]

`ContainerOptions.pivot`

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-69]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-70]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnId`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-71]

`ContainerOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-72]

`ContainerOptions.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-73]

`ContainerOptions.rotation`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-74]

`ContainerOptions.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-75]

`ContainerOptions.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-76]

`ContainerOptions.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-77]

`ContainerOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-78]

`ContainerOptions.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-79]

`ContainerOptions.tabIndex`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-80]

`ContainerOptions.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-81]

`ContainerOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-82]

`ContainerOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-83]

`ContainerOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-84]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-85]

`ContainerOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-86]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-87]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`zIndex`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#zindex)


# Interface: ContainerOptions<C> (/pixi-vn/index/interfaces/ContainerOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L10)

## Extends [#extends]

* `Omit`\<`PixiContainerOptions`\<`C`>, `"on"`>.[`AnchorExtensionProps`](/pixi-vn/index/interfaces/AnchorExtensionProps).[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Extended by [#extended-by]

* [`ImageContainerOptions`](/pixi-vn/index/interfaces/ImageContainerOptions)

## Type Parameters [#type-parameters]

### C [#c]

`C` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild) = [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`Omit.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`Omit.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`Omit.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`Omit.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`Omit.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`Omit.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`Omit.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: [src/canvas/components/AnchorExtension.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L4)

#### Inherited from [#inherited-from-9]

[`AnchorExtensionProps`](/pixi-vn/index/interfaces/AnchorExtensionProps).[`anchor`](/pixi-vn/index/interfaces/AnchorExtensionProps#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-11]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-12]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-13]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-14]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-15]

`Omit.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-16]

`Omit.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-17]

`Omit.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-18]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-19]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-20]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-22]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-28]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-49]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-61]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-62]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-63]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-66]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-71]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-74]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-75]

`Omit.tabIndex`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-76]

`Omit.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-77]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-78]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-79]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-80]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-81]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-82]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-83]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: DecayingEffectProps (/pixi-vn/index/interfaces/DecayingEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L29)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](#decay).

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Extended by [#extended-by]

* [`BlurPulseEffectProps`](/pixi-vn/index/interfaces/BlurPulseEffectProps)
* [`BounceEffectProps`](/pixi-vn/index/interfaces/BounceEffectProps)
* [`ChromaticAberrationEffectProps`](/pixi-vn/index/interfaces/ChromaticAberrationEffectProps)
* [`GlitchEffectProps`](/pixi-vn/index/interfaces/GlitchEffectProps)
* [`GlowPulseEffectProps`](/pixi-vn/index/interfaces/GlowPulseEffectProps)
* [`HopEffectProps`](/pixi-vn/index/interfaces/HopEffectProps)
* [`NodEffectProps`](/pixi-vn/index/interfaces/NodEffectProps)
* [`PulseEffectProps`](/pixi-vn/index/interfaces/PulseEffectProps)
* [`RadialBlurEffectProps`](/pixi-vn/index/interfaces/RadialBlurEffectProps)
* [`SwayEffectProps`](/pixi-vn/index/interfaces/SwayEffectProps)
* [`VignettePulseEffectProps`](/pixi-vn/index/interfaces/VignettePulseEffectProps)
* [`WiggleEffectProps`](/pixi-vn/index/interfaces/WiggleEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-3]

```ts
0.5
```

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: DesaturateEffectProps (/pixi-vn/index/interfaces/DesaturateEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:323](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L323)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### amount? [#amount]

\> `optional` **amount?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:328](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L328)

The saturation floor reached at the trough (`0` = full grayscale, `1` = no desaturation at all).

#### Default [#default-1]

```ts
0
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### holdDuration? [#holdduration]

\> `optional` **holdDuration?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L334)

How long the component stays at [amount](#amount) before recovering back to normal saturation, on
top of the fade in/out (each [AnimationOptions.duration](/pixi-vn/index/interfaces/BlurPulseEffectProps#duration)).

#### Default [#default-4]

```ts
0
```

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: DialogueInterface (/pixi-vn/index/interfaces/DialogueInterface)



Defined in: [src/narration/interfaces/DialogueInterface.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/DialogueInterface.ts#L3)

## Properties [#properties]

### character? [#character]

\> `optional` **character?**: `string` | `CharacterInterface`

Defined in: [src/narration/interfaces/DialogueInterface.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/DialogueInterface.ts#L11)

The id of the character that is speaking.

***

### text [#text]

\> **text**: `string` | `string`\[]

Defined in: [src/narration/interfaces/DialogueInterface.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/DialogueInterface.ts#L7)

The text of the dialogue.


# Interface: ExportedSound (/pixi-vn/index/interfaces/ExportedSound)



Defined in: [src/sound/interfaces/SoundGameState.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L6)

## Properties [#properties]

### filters? [#filters]

\> `optional` **filters?**: `SoundFilterMemory`\[]

Defined in: [src/sound/interfaces/SoundGameState.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L8)

***

### options [#options]

\> **options**: [`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions)

Defined in: [src/sound/interfaces/SoundGameState.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L7)


# Interface: ExportedSoundPlay (/pixi-vn/index/interfaces/ExportedSoundPlay)



Defined in: [src/sound/interfaces/SoundGameState.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L17)

## Extends [#extends]

* [`SoundPlay`](/pixi-vn/index/interfaces/SoundPlay)

## Properties [#properties]

### options? [#options]

\> `optional` **options?**: `string` | [`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

Defined in: [src/sound/interfaces/SoundGameState.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L14)

#### Inherited from [#inherited-from]

[`SoundPlay`](/pixi-vn/index/interfaces/SoundPlay).[`options`](/pixi-vn/index/interfaces/SoundPlay#options)

***

### paused [#paused]

\> **paused**: `boolean`

Defined in: [src/sound/interfaces/SoundGameState.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L13)

#### Inherited from [#inherited-from-1]

[`SoundPlay`](/pixi-vn/index/interfaces/SoundPlay).[`paused`](/pixi-vn/index/interfaces/SoundPlay#paused)

***

### sound [#sound]

\> **sound**: [`ExportedSound`](/pixi-vn/index/interfaces/ExportedSound)

Defined in: [src/sound/interfaces/SoundGameState.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L18)

***

### stepIndex [#stepindex]

\> **stepIndex**: `number`

Defined in: [src/sound/interfaces/SoundGameState.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L12)

#### Inherited from [#inherited-from-2]

[`SoundPlay`](/pixi-vn/index/interfaces/SoundPlay).[`stepIndex`](/pixi-vn/index/interfaces/SoundPlay#stepindex)


# Interface: FederatedEvent<N> (/pixi-vn/index/interfaces/FederatedEvent)



Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:105

A DOM-compatible synthetic event implementation for PixiJS's event system.
This class implements the standard DOM Event interface while providing additional
functionality specific to PixiJS events.
\> \[!NOTE] You wont receive an instance of this class directly, but rather a subclass
\> of this class, such as FederatedPointerEvent, FederatedMouseEvent, or
\> FederatedWheelEvent. This class is the base for all federated events.

## Example [#example]

```ts
// Basic event handling
sprite.on('pointerdown', (event: FederatedEvent) => {
    // Access standard DOM event properties
    console.log('Target:', event.target);
    console.log('Phase:', event.eventPhase);
    console.log('Type:', event.type);

    // Control propagation
    event.stopPropagation();
});
```

## Remarks [#remarks]

* Implements the standard DOM UIEvent interface
* Provides event bubbling and capturing phases
* Supports propagation control
* Manages event paths through display tree
* Normalizes native browser events

## See [#see]

* [https://dom.spec.whatwg.org/#event](https://dom.spec.whatwg.org/#event) DOM Event Specification
* FederatedPointerEvent For pointer-specific events
* FederatedMouseEvent For mouse-specific events
* FederatedWheelEvent For wheel-specific events

## Standard [#standard]

## Type Parameters [#type-parameters]

### N [#n]

`N` *extends* `UIEvent` | `PixiTouch` = `UIEvent` | `PixiTouch`

The type of native event held. Can be either a UIEvent or PixiTouch.

## Implements [#implements]

* `UIEvent`

## Properties [#properties]

### AT_TARGET [#at_target]

\> `readonly` **AT_TARGET**: `2` = `2`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:291

The event propagation phase AT_TARGET that indicates that the event is at the target.

#### Default [#default]

```ts
2
```

#### Advanced [#advanced]

#### Implementation of [#implementation-of]

`UIEvent.AT_TARGET`

***

### bubbles [#bubbles]

\> **bubbles**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:107

Flags whether this event bubbles. This will take effect only if it is set before propagation.

#### Implementation of [#implementation-of-1]

`UIEvent.bubbles`

***

### BUBBLING_PHASE [#bubbling_phase]

\> `readonly` **BUBBLING_PHASE**: `3` = `3`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:297

The event propagation phase BUBBLING_PHASE that indicates that the event is in the bubbling phase.

#### Default [#default-1]

```ts
3
```

#### Advanced [#advanced-1]

#### Implementation of [#implementation-of-2]

`UIEvent.BUBBLING_PHASE`

***

### cancelable [#cancelable]

\> `readonly` **cancelable**: `false` = `false`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:114

Flags whether this event can be canceled using [FederatedEvent.preventDefault](#preventdefault). This is always
false (for now).

#### Implementation of [#implementation-of-3]

`UIEvent.cancelable`

***

### ~~cancelBubble~~ [#cancelbubble]

\> **cancelBubble**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:109

#### Deprecated [#deprecated]

since 7.0.0

#### Implementation of [#implementation-of-4]

`UIEvent.cancelBubble`

***

### CAPTURING_PHASE [#capturing_phase]

\> `readonly` **CAPTURING_PHASE**: `1` = `1`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:285

The event propagation phase CAPTURING_PHASE that indicates that the event is in the capturing phase.

#### Default [#default-2]

```ts
1
```

#### Advanced [#advanced-2]

#### Implementation of [#implementation-of-5]

`UIEvent.CAPTURING_PHASE`

***

### currentTarget [#currenttarget]

\> **currentTarget**: `Container`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:123

The listeners of the event target that are being notified.

#### Implementation of [#implementation-of-6]

`UIEvent.currentTarget`

***

### defaultPrevented [#defaultprevented]

\> **defaultPrevented**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:125

Flags whether the default response of the user agent was prevent through this event.

#### Implementation of [#implementation-of-7]

`UIEvent.defaultPrevented`

***

### detail [#detail]

\> **detail**: `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:156

Event-specific detail

#### Implementation of [#implementation-of-8]

`UIEvent.detail`

***

### eventPhase [#eventphase]

\> **eventPhase**: `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:130

The propagation phase.

#### Default [#default-3]

[FederatedEvent.NONE](#none)

#### Implementation of [#implementation-of-9]

`UIEvent.eventPhase`

***

### isTrusted [#istrusted]

\> **isTrusted**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:132

Flags whether this is a user-trusted event

#### Implementation of [#implementation-of-10]

`UIEvent.isTrusted`

***

### layer [#layer]

\> **layer**: `Point`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:166

The coordinates of the event relative to the nearest DOM layer. This is a non-standard property.

***

### manager [#manager]

\> `readonly` **manager**: `EventBoundary`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:154

The EventBoundary that manages this event. Null for root events.

***

### nativeEvent [#nativeevent]

\> **nativeEvent**: `N`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:144

The native event that caused the foremost original event.

***

### NONE [#none]

\> `readonly` **NONE**: `0` = `0`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:279

The event propagation phase NONE that indicates that the event is not in any phase.

#### Default [#default-4]

```ts
0
```

#### Advanced [#advanced-3]

#### Implementation of [#implementation-of-11]

`UIEvent.NONE`

***

### originalEvent [#originalevent]

\> **originalEvent**: `FederatedEvent`\<`N`>

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:146

The original event that caused this event, if any.

***

### page [#page]

\> **page**: `Point`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:172

The coordinates of the event relative to the DOM document. This is a non-standard property.

***

### path [#path]

\> **path**: `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:152

The composed path of the event's propagation. The `target` is at the end.

***

### propagationImmediatelyStopped [#propagationimmediatelystopped]

\> **propagationImmediatelyStopped**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:150

Flags whether propagation was immediately stopped.

***

### propagationStopped [#propagationstopped]

\> **propagationStopped**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:148

Flags whether propagation was stopped.

***

### ~~returnValue~~ [#returnvalue]

\> **returnValue**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:134

#### Deprecated [#deprecated-1]

since 7.0.0

#### Implementation of [#implementation-of-12]

`UIEvent.returnValue`

***

### ~~srcElement~~ [#srcelement]

\> **srcElement**: `EventTarget`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:136

#### Deprecated [#deprecated-2]

since 7.0.0

#### Implementation of [#implementation-of-13]

`UIEvent.srcElement`

***

### target [#target]

\> **target**: `Container`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:138

The event target that this will be dispatched to.

#### Implementation of [#implementation-of-14]

`UIEvent.target`

***

### timeStamp [#timestamp]

\> **timeStamp**: `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:140

The timestamp of when the event was created.

#### Implementation of [#implementation-of-15]

`UIEvent.timeStamp`

***

### type [#type]

\> **type**: `string`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:142

The type of event, e.g. `"mouseup"`.

#### Implementation of [#implementation-of-16]

`UIEvent.type`

***

### view [#view]

\> **view**: `Window`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:158

The global Window object.

#### Implementation of [#implementation-of-17]

`UIEvent.view`

## Accessors [#accessors]

### data [#data]

#### Get Signature [#get-signature]

\> **get** **data**(): `this`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:186

Fallback for the deprecated `InteractionEvent.data`.

##### Deprecated [#deprecated-3]

since 7.0.0

##### Returns [#returns]

`this`

***

### layerX [#layerx]

#### Get Signature [#get-signature-1]

\> **get** **layerX**(): `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:168

##### Returns [#returns-1]

`number`

***

### layerY [#layery]

#### Get Signature [#get-signature-2]

\> **get** **layerY**(): `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:170

##### Returns [#returns-2]

`number`

***

### pageX [#pagex]

#### Get Signature [#get-signature-3]

\> **get** **pageX**(): `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:174

##### Returns [#returns-3]

`number`

***

### pageY [#pagey]

#### Get Signature [#get-signature-4]

\> **get** **pageY**(): `number`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:176

##### Returns [#returns-4]

`number`

## Methods [#methods]

### composedPath() [#composedpath]

\> **composedPath**(): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:191

The propagation path for this event. Alias for EventBoundary.propagationPath.

#### Returns [#returns-5]

`Container`\<`ContainerChild`>\[]

#### Advanced [#advanced-4]

#### Implementation of [#implementation-of-18]

`UIEvent.composedPath`

***

### preventDefault() [#preventdefault]

\> **preventDefault**(): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:229

Prevent default behavior of both PixiJS and the user agent.

#### Returns [#returns-6]

`void`

#### Example [#example-1]

```ts
sprite.on('click', (event) => {
    // Prevent both browser's default click behavior
    // and PixiJS's default handling
    event.preventDefault();

    // Custom handling
    customClickHandler();
});
```

#### Remarks [#remarks-1]

* Only works if the native event is cancelable
* Does not stop event propagation

#### Implementation of [#implementation-of-19]

`UIEvent.preventDefault`

***

### stopImmediatePropagation() [#stopimmediatepropagation]

\> **stopImmediatePropagation**(): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:249

Stop this event from propagating to any additional listeners, including those
on the current target and any following targets in the propagation path.

#### Returns [#returns-7]

`void`

#### Example [#example-2]

```ts
container.on('pointerdown', (event) => {
    // Stop all further event handling
    event.stopImmediatePropagation();

    // These handlers won't be called:
    // - Other pointerdown listeners on this container
    // - Any pointerdown listeners on parent containers
});
```

#### Remarks [#remarks-2]

* Immediately stops all event propagation
* Prevents other listeners on same target from being called
* More aggressive than stopPropagation()

#### Implementation of [#implementation-of-20]

`UIEvent.stopImmediatePropagation`

***

### stopPropagation() [#stoppropagation]

\> **stopPropagation**(): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:273

Stop this event from propagating to the next target in the propagation path.
The rest of the listeners on the current target will still be notified.

#### Returns [#returns-8]

`void`

#### Example [#example-3]

```ts
child.on('pointermove', (event) => {
    // Handle event on child
    updateChild();

    // Prevent parent handlers from being called
    event.stopPropagation();
});

// This won't be called if child handles the event
parent.on('pointermove', (event) => {
    updateParent();
});
```

#### Remarks [#remarks-3]

* Stops event bubbling to parent containers
* Does not prevent other listeners on same target
* Less aggressive than stopImmediatePropagation()

#### Implementation of [#implementation-of-21]

`UIEvent.stopPropagation`


# Interface: FilterFadeTransitionProps (/pixi-vn/index/interfaces/FilterFadeTransitionProps)



Defined in: [src/canvas/interfaces/transition-props.ts:173](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L173)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Extended by [#extended-by]

* [`GlitchInOutProps`](/pixi-vn/index/interfaces/GlitchInOutProps)
* [`NoiseDissolveInOutProps`](/pixi-vn/index/interfaces/NoiseDissolveInOutProps)
* [`PinchInOutProps`](/pixi-vn/index/interfaces/PinchInOutProps)
* [`RippleInOutProps`](/pixi-vn/index/interfaces/RippleInOutProps)
* [`TwistInOutProps`](/pixi-vn/index/interfaces/TwistInOutProps)
* [`WarpInOutProps`](/pixi-vn/index/interfaces/WarpInOutProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: FlashInOutProps (/pixi-vn/index/interfaces/FlashInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:101](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L101)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### color? [#color]

\> `optional` **color?**: [`ColorType`](/pixi-vn/index/type-aliases/ColorType)

Defined in: [src/canvas/interfaces/transition-props.ts:106](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L106)

The overlay color. See [ColorType](/pixi-vn/index/type-aliases/ColorType).

#### Default [#default-1]

```ts
0xffffff
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L130)

Whether the component itself also briefly fades in (`flashIn`) or out (`flashOut`) alongside the
color flash, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a
quarter of the flash's own duration, mirrored to the start of `flashIn`'s cycle or the end of
`flashOut`'s. Ignored when `flashIn` replaces an existing component (both sides are already
hidden under a solid `color` at the moment of the swap, so there's no pop to soften).

#### Default [#default-4]

```ts
true
```

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### holdDuration? [#holdduration]

\> `optional` **holdDuration?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:116](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L116)

How long (in seconds) the overlay stays at [maxAlpha](#maxalpha) before fading again.

#### Default [#default-5]

```ts
0
```

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### maxAlpha? [#maxalpha]

\> `optional` **maxAlpha?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:111](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L111)

The peak alpha the overlay reaches.

#### Default [#default-7]

```ts
1
```

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### pulses? [#pulses]

\> `optional` **pulses?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:121](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L121)

The number of times the overlay fades in and out.

#### Default [#default-8]

```ts
1
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: GameState (/pixi-vn/index/interfaces/GameState)



Defined in: [src/interfaces/GameState.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L7)

## Properties [#properties]

### canvasData [#canvasdata]

\> **canvasData**: [`CanvasGameState`](/pixi-vn/index/interfaces/CanvasGameState)

Defined in: [src/interfaces/GameState.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L11)

***

### historyData [#historydata]

\> **historyData**: [`HistoryGameState`](/pixi-vn/index/interfaces/HistoryGameState)

Defined in: [src/interfaces/GameState.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L13)

***

### path [#path]

\> **path**: `string`

Defined in: [src/interfaces/GameState.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L14)

***

### pixivn_version [#pixivn_version]

\> **pixivn_version**: `string`

Defined in: [src/interfaces/GameState.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L8)

***

### soundData [#sounddata]

\> **soundData**: [`SoundGameState`](/pixi-vn/index/interfaces/SoundGameState)

Defined in: [src/interfaces/GameState.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L12)

***

### stepData [#stepdata]

\> **stepData**: [`NarrationGameState`](/pixi-vn/index/interfaces/NarrationGameState)

Defined in: [src/interfaces/GameState.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L9)

***

### storageData [#storagedata]

\> **storageData**: [`StorageGameState`](/pixi-vn/index/interfaces/StorageGameState)

Defined in: [src/interfaces/GameState.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameState.ts#L10)


# Interface: GameStepStateData (/pixi-vn/index/interfaces/GameStepStateData)



Defined in: [src/interfaces/GameStepStateData.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L9)

It is a interface that contains the information of a step.

## Properties [#properties]

### canvas [#canvas]

\> **canvas**: [`CanvasGameState`](/pixi-vn/index/interfaces/CanvasGameState)

Defined in: [src/interfaces/GameStepStateData.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L25)

The canvas that occurred during the progression of the steps.

***

### labelIndex [#labelindex]

\> **labelIndex**: `number`

Defined in: [src/interfaces/GameStepStateData.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L21)

The index of the label that occurred during the progression of the steps.

***

### openedLabels [#openedlabels]

\> **openedLabels**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/interfaces/GameStepStateData.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L29)

The opened labels that occurred during the progression of the steps.

***

### path [#path]

\> **path**: `string`

Defined in: [src/interfaces/GameStepStateData.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L13)

The browser path that occurred during the progression of the steps.

***

### sound [#sound]

\> **sound**: [`SoundGameState`](/pixi-vn/index/interfaces/SoundGameState)

Defined in: [src/interfaces/GameStepStateData.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L33)

The sound data that occurred during the progression of the steps.

***

### storage [#storage]

\> **storage**: [`StorageGameState`](/pixi-vn/index/interfaces/StorageGameState)

Defined in: [src/interfaces/GameStepStateData.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/interfaces/GameStepStateData.ts#L17)

The storage that occurred during the progression of the steps.


# Interface: GameTestingAPI<TGame, T> (/pixi-vn/index/interfaces/GameTestingAPI)



Defined in: [src/core/testing.ts:46](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L46)

The object attached to `window` (and returned) by `enable`. Every action method
merges the most recent props passed to `setProps` with any `extraProps` given here,
then delegates to the matching narration/history call — so calling these behaves exactly
like a real player action (the same `navigate`/`t`/`toast`/etc. the real UI uses).

`narration`, `storage`, `stepHistory` and `Game` are also exposed directly for anything not
covered by the action methods (e.g. `storage.set(...)`, `Game.exportGameState()`).

## Type Parameters [#type-parameters]

### TGame [#tgame]

`TGame`

### T [#t]

`T` *extends* `object` = \{ }

## Properties [#properties]

### errors [#errors]

\> `readonly` **errors**: [`GameTestingErrorEntry`](/pixi-vn/index/interfaces/GameTestingErrorEntry)\[]

Defined in: [src/core/testing.ts:101](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L101)

Errors caught via `Game.addOnError` since `enable()` was called (or since the last [clearErrors](#clearerrors)).

***

### Game [#game]

\> `readonly` **Game**: `TGame`

Defined in: [src/core/testing.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L47)

***

### narration [#narration]

\> `readonly` **narration**: [`NarrationManagerInterface`](/pixi-vn/index/interfaces/NarrationManagerInterface)

Defined in: [src/core/testing.ts:48](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L48)

***

### props [#props]

\> `readonly` **props**: [`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

Defined in: [src/core/testing.ts:57](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L57)

The most recent props passed to `setProps` — whatever your app's `StepLabelProps`
augmentation defines (e.g. `navigate`, `toast`). Useful to drive the app's UI directly
during a test session — e.g. `pixiVN.props.navigate("/settings")` — not just narration,
for full control over what's on screen.

***

### stepHistory [#stephistory]

\> `readonly` **stepHistory**: [`HistoryManagerInterface`](/pixi-vn/index/interfaces/HistoryManagerInterface)

Defined in: [src/core/testing.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L50)

***

### storage [#storage]

\> `readonly` **storage**: [`StorageManagerInterface`](/pixi-vn/index/interfaces/StorageManagerInterface)

Defined in: [src/core/testing.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L49)

## Methods [#methods]

### call() [#call]

\> **call**(`label`, `extraProps?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L69)

[narrationUtils.NarrationManagerInterface.call](/pixi-vn/index/interfaces/NarrationManagerInterface#call) using the live props plus any `extraProps`.

#### Parameters [#parameters]

##### label [#label]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### extraProps? [#extraprops]

`Partial`\<`T`>

#### Returns [#returns]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### clearErrors() [#clearerrors]

\> **clearErrors**(): `void`

Defined in: [src/core/testing.ts:102](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L102)

#### Returns [#returns-1]

`void`

***

### closeAllLabels() [#closealllabels]

\> **closeAllLabels**(): `void`

Defined in: [src/core/testing.ts:97](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L97)

[narrationUtils.NarrationLabelsInterface.closeAll](/pixi-vn/index/interfaces/NarrationLabelsInterface#closeall). **Can end the game.**

#### Returns [#returns-2]

`void`

***

### closeCurrentLabel() [#closecurrentlabel]

\> **closeCurrentLabel**(): `void`

Defined in: [src/core/testing.ts:95](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L95)

[narrationUtils.NarrationLabelsInterface.closeCurrent](/pixi-vn/index/interfaces/NarrationLabelsInterface#closecurrent)

#### Returns [#returns-3]

`void`

***

### continue() [#continue]

\> **continue**(`extraProps?`, `options?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L64)

[narrationUtils.NarrationManagerInterface.continue](/pixi-vn/index/interfaces/NarrationManagerInterface#continue) using the live props plus any `extraProps`.

#### Parameters [#parameters-1]

##### extraProps? [#extraprops-1]

`Partial`\<`T`>

##### options? [#options]

###### runNow? [#runnow]

`boolean`

###### steps? [#steps]

`number`

#### Returns [#returns-4]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### getState() [#getstate]

\> **getState**(): [`GameTestingState`](/pixi-vn/index/interfaces/GameTestingState)

Defined in: [src/core/testing.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L99)

A snapshot of dialogue/choices/input/canContinue/canGoBack/labels — see [GameTestingState](/pixi-vn/index/interfaces/GameTestingState).

#### Returns [#returns-5]

[`GameTestingState`](/pixi-vn/index/interfaces/GameTestingState)

***

### goBack() [#goback]

\> **goBack**(`extraProps?`, `options?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:90](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L90)

[historyUtils.HistoryManagerInterface.back](/pixi-vn/index/interfaces/HistoryManagerInterface#back) using the live props plus any `extraProps`.

#### Parameters [#parameters-2]

##### extraProps? [#extraprops-2]

`Partial`\<`T`>

##### options? [#options-1]

###### steps? [#steps-1]

`number`

#### Returns [#returns-6]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### jump() [#jump]

\> **jump**(`label`, `extraProps?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L74)

[narrationUtils.NarrationManagerInterface.jump](/pixi-vn/index/interfaces/NarrationManagerInterface#jump) using the live props plus any `extraProps`.

#### Parameters [#parameters-3]

##### label [#label-1]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### extraProps? [#extraprops-3]

`Partial`\<`T`>

#### Returns [#returns-7]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### selectChoice() [#selectchoice]

\> **selectChoice**(`choiceIndex`, `extraProps?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L83)

Selects the currently open choice with this `choiceIndex` (as seen in
`getState().choices`), using the live props plus any `extraProps`.

#### Parameters [#parameters-4]

##### choiceIndex [#choiceindex]

`number`

##### extraProps? [#extraprops-4]

`Partial`\<`T`>

#### Returns [#returns-8]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

#### Throws [#throws]

when no open choice has that index.

***

### setInput() [#setinput]

\> **setInput**(`value`): `void`

Defined in: [src/core/testing.ts:88](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L88)

Resolves a pending `narration.input.request(...)` with `value`, exactly like the player typing an answer and confirming.

#### Parameters [#parameters-5]

##### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

#### Returns [#returns-9]

`void`

***

### start() [#start]

\> **start**(`label`, `extraProps?`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L59)

`Game.start` using the live props plus any `extraProps`.

#### Parameters [#parameters-6]

##### label [#label-2]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### extraProps? [#extraprops-5]

`Partial`\<`T`>

#### Returns [#returns-10]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>


# Interface: GameTestingActions<T> (/pixi-vn/index/interfaces/GameTestingActions)



Defined in: [src/core/testing.ts:118](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L118)

Per-action overrides an app can register via `setActions` so `Game.testing`'s
window-exposed actions run the app's own narration functions — with whatever UI-only side
effects they add (loading state, blocking while a menu is open, refreshing cached interface
data, ...) — instead of calling [narrationUtils.narration](/pixi-vn/index/variables/narration) / historyUtils.stepHistory directly. Any action left undefined keeps the default behavior.

`continue`/`back` take no arguments: the `extraProps`/`options` a caller passes to the
corresponding [GameTestingAPI](/pixi-vn/index/interfaces/GameTestingAPI) method are ignored when an override is registered,
since the override already has its own way to gather props (and typically doesn't support
stepped/replay options). `selectChoice` receives the resolved choice item instead of the
raw `choiceIndex`, since looking it up is already handled before the override runs.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }

## Properties [#properties]

### back? [#back]

\> `optional` **back?**: () => `Promise`\<`void`>

Defined in: [src/core/testing.ts:120](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L120)

#### Returns [#returns]

`Promise`\<`void`>

***

### call? [#call]

\> `optional` **call?**: (`label`, `props?`) => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L130)

#### Parameters [#parameters]

##### label [#label]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### props? [#props]

`T`

#### Returns [#returns-1]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### continue? [#continue]

\> `optional` **continue?**: () => `Promise`\<`void`>

Defined in: [src/core/testing.ts:119](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L119)

#### Returns [#returns-2]

`Promise`\<`void`>

***

### jump? [#jump]

\> `optional` **jump?**: (`label`, `props?`) => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/core/testing.ts:126](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L126)

#### Parameters [#parameters-1]

##### label [#label-1]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### props? [#props-1]

`T`

#### Returns [#returns-3]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### selectChoice? [#selectchoice]

\> `optional` **selectChoice?**: (`item`) => `Promise`\<`void`>

Defined in: [src/core/testing.ts:121](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L121)

#### Parameters [#parameters-2]

##### item [#item]

[`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)

#### Returns [#returns-4]

`Promise`\<`void`>

***

### start? [#start]

\> `optional` **start?**: (`label`, `props?`) => `Promise`\<`void`>

Defined in: [src/core/testing.ts:122](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L122)

#### Parameters [#parameters-3]

##### label [#label-2]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

##### props? [#props-2]

`T`

#### Returns [#returns-5]

`Promise`\<`void`>


# Interface: GameTestingErrorEntry (/pixi-vn/index/interfaces/GameTestingErrorEntry)



Defined in: [src/core/testing.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L11)

One error captured by createGameTesting's `enable` while testing is active, via
`Game.addOnError`.

## Properties [#properties]

### error [#error]

\> **error**: `unknown`

Defined in: [src/core/testing.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L12)

***

### timestamp [#timestamp]

\> **timestamp**: `number`

Defined in: [src/core/testing.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L13)


# Interface: GameTestingState (/pixi-vn/index/interfaces/GameTestingState)



Defined in: [src/core/testing.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L21)

A read-only snapshot of everything a test session typically needs to decide its next
action, gathered from [narrationUtils.narration](/pixi-vn/index/variables/narration) and [historyUtils.stepHistory](/pixi-vn/index/variables/stepHistory)
in a single call instead of reading several properties one by one.

## Properties [#properties]

### canContinue [#cancontinue]

\> **canContinue**: `boolean`

Defined in: [src/core/testing.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L30)

***

### canGoBack [#cangoback]

\> **canGoBack**: `boolean`

Defined in: [src/core/testing.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L31)

***

### choices [#choices]

\> **choices**: [`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)\[] | `undefined`

Defined in: [src/core/testing.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L24)

***

### currentLabelId [#currentlabelid]

\> **currentLabelId**: `string` | `undefined`

Defined in: [src/core/testing.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L33)

***

### dialogue [#dialogue]

\> **dialogue**: [`DialogueInterface`](/pixi-vn/index/interfaces/DialogueInterface) | `undefined`

Defined in: [src/core/testing.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L22)

***

### dialogueGlue [#dialogueglue]

\> **dialogueGlue**: `boolean`

Defined in: [src/core/testing.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L23)

***

### input [#input]

\> **input**: `object`

Defined in: [src/core/testing.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L25)

#### isRequired [#isrequired]

\> **isRequired**: `boolean`

#### type [#type]

\> **type**: `string` | `undefined`

#### value [#value]

\> **value**: [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

***

### labelsOpened [#labelsopened]

\> **labelsOpened**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/core/testing.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L32)

***

### stepCounter [#stepcounter]

\> **stepCounter**: `number`

Defined in: [src/core/testing.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/testing.ts#L34)


# Interface: GlitchEffectProps (/pixi-vn/index/interfaces/GlitchEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:163](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L163)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### bursts? [#bursts]

\> `optional` **bursts?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:173](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L173)

The number of glitch bursts.

#### Default [#default-1]

```ts
3
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:183](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L183)

The angle (in degrees) slices are displaced along.

#### Default [#default-5]

```ts
0
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### rgbSplit? [#rgbsplit]

\> `optional` **rgbSplit?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:189](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L189)

The peak red/blue channel separation (pixels) layered on top of the slice displacement,
following the same jittery envelope. `0` disables it.

#### Default [#default-7]

```ts
6
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### slices? [#slices]

\> `optional` **slices?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:178](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L178)

The number of glitch slices.

#### Default [#default-8]

```ts
8
```

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:168](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L168)

The peak slice-displacement amount (pixels) of the first, largest burst.

#### Default [#default-10]

```ts
40
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-12]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: GlitchInOutProps (/pixi-vn/index/interfaces/GlitchInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:181](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L181)

Shared options for the filter-based reveal/conceal transitions (GlitchInOutProps,
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### bursts? [#bursts]

\> `optional` **bursts?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:191](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L191)

The number of glitch bursts.

#### Default [#default-1]

```ts
3
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### rgbSplit? [#rgbsplit]

\> `optional` **rgbSplit?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:202](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L202)

The peak red/blue channel separation (pixels) layered on top of the slices, following the same
envelope. `0` disables it.

#### Default [#default-5]

```ts
6
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### slices? [#slices]

\> `optional` **slices?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:196](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L196)

The number of glitch slices.

#### Default [#default-6]

```ts
8
```

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:186](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L186)

The peak slice-displacement (pixels) - the first burst of `glitchIn`, the last of `glitchOut`.

#### Default [#default-8]

```ts
40
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: GlowPulseEffectProps (/pixi-vn/index/interfaces/GlowPulseEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:337](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L337)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### color? [#color]

\> `optional` **color?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:352](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L352)

The color of the glow.

#### Default [#default-1]

```ts
0xffffff
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### distance? [#distance]

\> `optional` **distance?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:357](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L357)

The distance (in pixels) the glow extends.

#### Default [#default-5]

```ts
10
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### innerStrength? [#innerstrength]

\> `optional` **innerStrength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:362](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L362)

The strength of the glow inward from the edge of the component.

#### Default [#default-6]

```ts
0
```

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-7]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### pulses? [#pulses]

\> `optional` **pulses?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:347](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L347)

The number of pulses.

#### Default [#default-8]

```ts
3
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:342](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L342)

The peak outward glow strength of the first, largest pulse.

#### Default [#default-10]

```ts
4
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-12]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: HistoryGameState (/pixi-vn/index/interfaces/HistoryGameState)



Defined in: [src/history/interfaces/HistoryGameState.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryGameState.ts#L7)

Interface exported step data

## Properties [#properties]

### originalStepData [#originalstepdata]

\> **originalStepData**: `GameStepState` | `undefined`

Defined in: [src/history/interfaces/HistoryGameState.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryGameState.ts#L9)

***

### stepsHistory [#stepshistory]

\> **stepsHistory**: [`HistoryStep`](/pixi-vn/index/interfaces/HistoryStep)\[]

Defined in: [src/history/interfaces/HistoryGameState.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryGameState.ts#L8)


# Interface: HistoryManagerInterface (/pixi-vn/index/interfaces/HistoryManagerInterface)



Defined in: [src/history/interfaces/HistoryManagerInterface.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L13)

## Properties [#properties]

### back [#back]

\> **back**: (`props`, `options?`) => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:73](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L73)

Go back to the last step and add it to the history.

#### Parameters [#parameters]

##### props [#props]

`StepLabelProps`

The step label properties.

##### options? [#options]

The navigation options.

###### steps? [#steps]

`number`

The number of steps to go back. Must be greater than 0.

**Default**

```ts
1
```

#### Returns [#returns]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

***

### canGoBack [#cangoback]

\> `readonly` **canGoBack**: `boolean`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:89](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L89)

Return true if it is possible to go back.

***

### currentLabelHistory [#currentlabelhistory]

\> `readonly` **currentLabelHistory**: [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory)\[]

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:40](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L40)

Get the history of the latest steps belonging to the current label and its child labels.

This is effectively the current "page" of an interactive book: it starts over every time a
[NarrationManagerInterface.jump](/pixi-vn/index/interfaces/NarrationManagerInterface#jump) is performed.

#### Returns [#returns-1]

the history of the dialogues, choices and steps

***

### currentPageParagraphs [#currentpageparagraphs]

\> `readonly` **currentPageParagraphs**: [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory)\[]\[]

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:50](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L50)

Get the current page ([HistoryManagerInterface.currentLabelHistory](#currentlabelhistory)) split into paragraphs.

A new paragraph starts every time the number of opened labels changes compared to the previous step
(i.e. a [NarrationManagerInterface.call](/pixi-vn/index/interfaces/NarrationManagerInterface#call) was made, or a called label returned), using
[NarrationHistory.openedLabelsNumber](/pixi-vn/index/interfaces/NarrationHistory#openedlabelsnumber).

#### Returns [#returns-2]

the current page as an ordered list of paragraphs, each one a list of steps

***

### diffMap [#diffmap]

\> `readonly` **diffMap**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, `Difference`\[]>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:149](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L149)

Map that contains all the differences between the steps in the history.
The differences will be used to restore a step.

**Don't edit unless you're sure what you're doing.**

***

### goBackMode [#gobackmode]

\> **goBackMode**: [`HistoryGoBackModeType`](/pixi-vn/index/type-aliases/HistoryGoBackModeType)

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L26)

How often a go-back-able checkpoint is recorded.

#### Default [#default]

"step"

* `"step"`: every single narration step, matching visual-novel-style games where
  the player may want to undo one line/sprite change at a time.
* `"paragraph"`: only when a new paragraph starts ([HistoryManagerInterface.currentPageParagraphs](#currentpageparagraphs)),
  a choice is proposed, or an input is requested - matching book-style narrations
  where undoing mid-paragraph doesn't make sense to the player. Every step within a
  paragraph is merged into the checkpoint that closes it out: `back()` from anywhere
  inside paragraph N jumps all the way to the *start* of paragraph N-1, not to
  wherever you were right before N began - the whole of paragraph N-1 gets replayed.

***

### lastKey [#lastkey]

\> `readonly` **lastKey**: `number` | `null`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:118](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L118)

Get the last key (id) of the history.

***

### narrationMap [#narrationmap]

\> `readonly` **narrationMap**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory)>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:155](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L155)

Map that contains all the narration history.

**Don't edit unless you're sure what you're doing.**

***

### narrativeHistory [#narrativehistory]

\> `readonly` **narrativeHistory**: [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory)\[]

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L31)

Get the narrative history.

#### Returns [#returns-3]

the history of the dialogues, choices and steps

***

### size [#size]

\> `readonly` **size**: `number`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:114](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L114)

Number of items in the history.

***

### stepLimitSaved [#steplimitsaved]

\> **stepLimitSaved**: `number`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:61](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L61)

The number of steps to keep in the history into the save file.

The other older steps will be compressed will be used in [HistoryManagerInterface.narrativeHistory](#narrativehistory) to show the older dialogues.
In the compressed steps, the canvas and storage information will be removed.

This also means that a player, after saving and loading a save, will only be able to go back to NarrationManagerInterface.stepLimitSaved steps.

If you want to keep all steps in the history, you can set this value to Infinity.

***

### stepsInfoMap [#stepsinfomap]

\> `readonly` **stepsInfoMap**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`number`, `Omit`\<[`HistoryStep`](/pixi-vn/index/interfaces/HistoryStep), `"diff"`>>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:142](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L142)

Map that contains all information about the steps in the history.

**Don't edit unless you're sure what you're doing.**

## Methods [#methods]

### add() [#add]

\> **add**(`historyInfo?`, `opstions?`): `Promise`\<`void`>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L98)

Add a step to the history.

#### Parameters [#parameters-1]

##### historyInfo? [#historyinfo]

`HistoryInfo`

Info about the step to add.

##### opstions? [#opstions]

Options to add the step.

###### ignoreSameStep? [#ignoresamestep]

`boolean`

If true, the step will not be added to the history if the current step is the same as the last step.

#### Returns [#returns-4]

`Promise`\<`void`>

***

### blockGoBack() [#blockgoback]

\> **blockGoBack**(): `void`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:85](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L85)

Block the go back function.

#### Returns [#returns-5]

`void`

***

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:110](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L110)

Clear the history.

#### Returns [#returns-6]

`void`

***

### delete() [#delete]

\> **delete**(`stepIndex`): `void`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:136](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L136)

Remove a step from the history.

#### Parameters [#parameters-2]

##### stepIndex [#stepindex]

`number`

The key (id) of the step to remove.

#### Returns [#returns-7]

`void`

True if the step was removed, false if it was not found.

***

### export() [#export]

\> **export**(): `Promise`\<[`HistoryGameState`](/pixi-vn/index/interfaces/HistoryGameState)>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:163](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L163)

Export the history to an object.

#### Returns [#returns-8]

`Promise`\<[`HistoryGameState`](/pixi-vn/index/interfaces/HistoryGameState)>

The history in an object.

***

### get() [#get]

\> **get**(`stepIndex`): [`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory) | `undefined`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L130)

Get a step from the history.

**Note:** If the step not contains any information, this method will return undefined.

#### Parameters [#parameters-3]

##### stepIndex [#stepindex-1]

`number`

The key (id) of the step to get.

#### Returns [#returns-9]

[`NarrationHistory`](/pixi-vn/index/interfaces/NarrationHistory) | `undefined`

The step.

***

### keys() [#keys]

\> **keys**(): `MapIterator`\<`number`>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:122](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L122)

Get all the keys (id) of the history.

#### Returns [#returns-10]

`MapIterator`\<`number`>

***

### removeNarrativeHistory() [#removenarrativehistory]

\> **removeNarrativeHistory**(`itemsNumber?`): `void`

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:66](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L66)

Delete the narrative history.

#### Parameters [#parameters-4]

##### itemsNumber? [#itemsnumber]

`number`

The number of items to delete. If undefined, all items will be deleted.

#### Returns [#returns-11]

`void`

***

### restore() [#restore]

\> **restore**(`data`): `Promise`\<`void`>

Defined in: [src/history/interfaces/HistoryManagerInterface.ts:168](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/interfaces/HistoryManagerInterface.ts#L168)

Restore the history from an object.

#### Parameters [#parameters-5]

##### data [#data]

`object`

The history in an object.

#### Returns [#returns-12]

`Promise`\<`void`>


# Interface: HistoryStep (/pixi-vn/index/interfaces/HistoryStep)



Defined in: [src/narration/interfaces/HistoryStep.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L20)

## Properties [#properties]

### alreadyMadeChoices? [#alreadymadechoices]

\> `optional` **alreadyMadeChoices?**: `number`\[]

Defined in: [src/narration/interfaces/HistoryStep.ts:52](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L52)

List of choices already made by the player

***

### choiceIndexMade? [#choiceindexmade]

\> `optional` **choiceIndexMade?**: `number`

Defined in: [src/narration/interfaces/HistoryStep.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L65)

The choice made by the player

***

### choices? [#choices]

\> `optional` **choices?**: [`StoredChoiceInterface`](/pixi-vn/index/type-aliases/StoredChoiceInterface)\[]

Defined in: [src/narration/interfaces/HistoryStep.ts:48](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L48)

List of choices asked of the player

***

### currentLabel? [#currentlabel]

\> `optional` **currentLabel?**: `string`

Defined in: [src/narration/interfaces/HistoryStep.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L28)

The label id of the current step.

***

### dialogue? [#dialogue]

\> `optional` **dialogue?**: `StoredDialogue`

Defined in: [src/narration/interfaces/HistoryStep.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L44)

Dialogue to be shown in the game

***

### diff? [#diff]

\> `optional` **diff?**: `Difference`\[]

Defined in: [src/narration/interfaces/HistoryStep.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L24)

The difference between the previous step and the current step.

***

### index [#index]

\> **index**: `number`

Defined in: [src/narration/interfaces/HistoryStep.ts:36](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L36)

Equivalent to the narration.stepCounter

***

### inputValue? [#inputvalue]

\> `optional` **inputValue?**: [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

Defined in: [src/narration/interfaces/HistoryStep.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L56)

The input value of the player

***

### isGlued? [#isglued]

\> `optional` **isGlued?**: `boolean`

Defined in: [src/narration/interfaces/HistoryStep.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L69)

If true, the current dialogue will be glued to the previous one.

***

### isRequiredInput? [#isrequiredinput]

\> `optional` **isRequiredInput?**: `boolean`

Defined in: [src/narration/interfaces/HistoryStep.ts:61](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L61)

Whether this step requested an input from the player (regardless of whether a
default value was provided, unlike [inputValue](#inputvalue) which is only set when one is).

***

### labelStepIndex [#labelstepindex]

\> **labelStepIndex**: `number` | `null`

Defined in: [src/narration/interfaces/HistoryStep.ts:40](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L40)

The data of the step of the label.

***

### openedLabels? [#openedlabels]

\> `optional` **openedLabels?**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/interfaces/HistoryStep.ts:73](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L73)

Opened Labels in the current step.

***

### stepSha1 [#stepsha1]

\> **stepSha1**: `string`

Defined in: [src/narration/interfaces/HistoryStep.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/HistoryStep.ts#L32)

The sha1 of the step function.


# Interface: HopEffectProps (/pixi-vn/index/interfaces/HopEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:70](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L70)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
HopEffectProps, [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/effect-props.ts:75](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L75)

The direction of the (primary and any secondary) hops.

#### Default [#default-4]

```ts
"up"
```

***

### distance? [#distance]

\> `optional` **distance?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:80](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L80)

The distance (in pixels) of the primary hop.

#### Default [#default-5]

```ts
40
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### secondaryHops? [#secondaryhops]

\> `optional` **secondaryHops?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:85](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L85)

The number of smaller, decaying hops to play after the primary one (`0` = just the one hop).

#### Default [#default-7]

```ts
0
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-8]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: HslColorType (/pixi-vn/index/interfaces/HslColorType)



Defined in: [src/canvas/types/ColorType.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L9)

## Extended by [#extended-by]

* [`HslaColorType`](/pixi-vn/index/interfaces/HslaColorType)

## Properties [#properties]

### h [#h]

\> **h**: `number`

Defined in: [src/canvas/types/ColorType.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L10)

***

### l [#l]

\> **l**: `number`

Defined in: [src/canvas/types/ColorType.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L12)

***

### s [#s]

\> **s**: `number`

Defined in: [src/canvas/types/ColorType.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L11)


# Interface: HslaColorType (/pixi-vn/index/interfaces/HslaColorType)



Defined in: [src/canvas/types/ColorType.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L14)

## Extends [#extends]

* [`HslColorType`](/pixi-vn/index/interfaces/HslColorType)

## Properties [#properties]

### a [#a]

\> **a**: `number`

Defined in: [src/canvas/types/ColorType.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L15)

***

### h [#h]

\> **h**: `number`

Defined in: [src/canvas/types/ColorType.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L10)

#### Inherited from [#inherited-from]

[`HslColorType`](/pixi-vn/index/interfaces/HslColorType).[`h`](/pixi-vn/index/interfaces/HslColorType#h)

***

### l [#l]

\> **l**: `number`

Defined in: [src/canvas/types/ColorType.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L12)

#### Inherited from [#inherited-from-1]

[`HslColorType`](/pixi-vn/index/interfaces/HslColorType).[`l`](/pixi-vn/index/interfaces/HslColorType#l)

***

### s [#s]

\> **s**: `number`

Defined in: [src/canvas/types/ColorType.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L11)

#### Inherited from [#inherited-from-2]

[`HslColorType`](/pixi-vn/index/interfaces/HslColorType).[`s`](/pixi-vn/index/interfaces/HslColorType#s)


# Interface: HsvColorType (/pixi-vn/index/interfaces/HsvColorType)



Defined in: [src/canvas/types/ColorType.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L17)

## Extended by [#extended-by]

* [`HsvaColorType`](/pixi-vn/index/interfaces/HsvaColorType)

## Properties [#properties]

### h [#h]

\> **h**: `number`

Defined in: [src/canvas/types/ColorType.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L18)

***

### s [#s]

\> **s**: `number`

Defined in: [src/canvas/types/ColorType.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L19)

***

### v [#v]

\> **v**: `number`

Defined in: [src/canvas/types/ColorType.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L20)


# Interface: HsvaColorType (/pixi-vn/index/interfaces/HsvaColorType)



Defined in: [src/canvas/types/ColorType.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L22)

## Extends [#extends]

* [`HsvColorType`](/pixi-vn/index/interfaces/HsvColorType)

## Properties [#properties]

### a [#a]

\> **a**: `number`

Defined in: [src/canvas/types/ColorType.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L23)

***

### h [#h]

\> **h**: `number`

Defined in: [src/canvas/types/ColorType.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L18)

#### Inherited from [#inherited-from]

[`HsvColorType`](/pixi-vn/index/interfaces/HsvColorType).[`h`](/pixi-vn/index/interfaces/HsvColorType#h)

***

### s [#s]

\> **s**: `number`

Defined in: [src/canvas/types/ColorType.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L19)

#### Inherited from [#inherited-from-1]

[`HsvColorType`](/pixi-vn/index/interfaces/HsvColorType).[`s`](/pixi-vn/index/interfaces/HsvColorType#s)

***

### v [#v]

\> **v**: `number`

Defined in: [src/canvas/types/ColorType.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L20)

#### Inherited from [#inherited-from-2]

[`HsvColorType`](/pixi-vn/index/interfaces/HsvColorType).[`v`](/pixi-vn/index/interfaces/HsvColorType#v)


# Interface: ImageContainerMemory (/pixi-vn/index/interfaces/ImageContainerMemory)



Defined in: [src/canvas/interfaces/memory/ImageContainerMemory.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageContainerMemory.ts#L9)

Interface for the canvas container memory

## Extends [#extends]

* [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)\<[`ImageSprite`](/pixi-vn/index/classes/ImageSprite)>

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessible`](/pixi-vn/index/interfaces/ContainerMemory#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessibleChildren`](/pixi-vn/index/interfaces/ContainerMemory#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessibleHint`](/pixi-vn/index/interfaces/ContainerMemory#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/ContainerMemory#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessibleText`](/pixi-vn/index/interfaces/ContainerMemory#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessibleTitle`](/pixi-vn/index/interfaces/ContainerMemory#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`accessibleType`](/pixi-vn/index/interfaces/ContainerMemory#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`align`](/pixi-vn/index/interfaces/ContainerMemory#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `PointData`

Defined in: [src/canvas/interfaces/memory/ImageContainerMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageContainerMemory.ts#L11)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-9]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`angle`](/pixi-vn/index/interfaces/ContainerMemory#angle)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-10]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-11]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-12]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: [`ImageSprite`](/pixi-vn/index/classes/ImageSprite)\<[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)>\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-13]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`children`](/pixi-vn/index/interfaces/ContainerMemory#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-14]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cullable`](/pixi-vn/index/interfaces/ContainerMemory#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-15]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cullableChildren`](/pixi-vn/index/interfaces/ContainerMemory#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-16]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cullArea`](/pixi-vn/index/interfaces/ContainerMemory#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-17]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cursor`](/pixi-vn/index/interfaces/ContainerMemory#cursor)

***

### elements [#elements]

\> **elements**: [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)\[]

Defined in: [src/canvas/interfaces/memory/ImageContainerMemory.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageContainerMemory.ts#L10)

The elements contained in this container

#### Overrides [#overrides]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`elements`](/pixi-vn/index/interfaces/ContainerMemory#elements)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-18]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`eventMode`](/pixi-vn/index/interfaces/ContainerMemory#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-19]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-20]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`hitArea`](/pixi-vn/index/interfaces/ContainerMemory#hitarea)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-22]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`index`](/pixi-vn/index/interfaces/ContainerMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`interactive`](/pixi-vn/index/interfaces/ContainerMemory#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`interactiveChildren`](/pixi-vn/index/interfaces/ContainerMemory#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### loadIsStarted [#loadisstarted]

\> **loadIsStarted**: `boolean`

Defined in: [src/canvas/interfaces/memory/ImageContainerMemory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageContainerMemory.ts#L12)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onclick`](/pixi-vn/index/interfaces/ContainerMemory#onclick)

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-28]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onEvents`](/pixi-vn/index/interfaces/ContainerMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onglobalmousemove`](/pixi-vn/index/interfaces/ContainerMemory#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onglobalpointermove`](/pixi-vn/index/interfaces/ContainerMemory#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onglobaltouchmove`](/pixi-vn/index/interfaces/ContainerMemory#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmousedown`](/pixi-vn/index/interfaces/ContainerMemory#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseenter`](/pixi-vn/index/interfaces/ContainerMemory#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseleave`](/pixi-vn/index/interfaces/ContainerMemory#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmousemove`](/pixi-vn/index/interfaces/ContainerMemory#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseout`](/pixi-vn/index/interfaces/ContainerMemory#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseover`](/pixi-vn/index/interfaces/ContainerMemory#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseup`](/pixi-vn/index/interfaces/ContainerMemory#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onmouseupoutside`](/pixi-vn/index/interfaces/ContainerMemory#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointercancel`](/pixi-vn/index/interfaces/ContainerMemory#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerdown`](/pixi-vn/index/interfaces/ContainerMemory#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerenter`](/pixi-vn/index/interfaces/ContainerMemory#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerleave`](/pixi-vn/index/interfaces/ContainerMemory#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointermove`](/pixi-vn/index/interfaces/ContainerMemory#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerout`](/pixi-vn/index/interfaces/ContainerMemory#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerover`](/pixi-vn/index/interfaces/ContainerMemory#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointertap`](/pixi-vn/index/interfaces/ContainerMemory#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerup`](/pixi-vn/index/interfaces/ContainerMemory#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onpointerupoutside`](/pixi-vn/index/interfaces/ContainerMemory#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onrightclick`](/pixi-vn/index/interfaces/ContainerMemory#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onrightdown`](/pixi-vn/index/interfaces/ContainerMemory#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onrightup`](/pixi-vn/index/interfaces/ContainerMemory#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onrightupoutside`](/pixi-vn/index/interfaces/ContainerMemory#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontap`](/pixi-vn/index/interfaces/ContainerMemory#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontouchcancel`](/pixi-vn/index/interfaces/ContainerMemory#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontouchend`](/pixi-vn/index/interfaces/ContainerMemory#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontouchendoutside`](/pixi-vn/index/interfaces/ContainerMemory#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontouchmove`](/pixi-vn/index/interfaces/ContainerMemory#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`ontouchstart`](/pixi-vn/index/interfaces/ContainerMemory#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onwheel`](/pixi-vn/index/interfaces/ContainerMemory#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`origin`](/pixi-vn/index/interfaces/ContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-63]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`parent`](/pixi-vn/index/interfaces/ContainerMemory#parent)

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-64]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`parentLabel`](/pixi-vn/index/interfaces/ContainerMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`percentagePosition`](/pixi-vn/index/interfaces/ContainerMemory#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`percentageX`](/pixi-vn/index/interfaces/ContainerMemory#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`percentageY`](/pixi-vn/index/interfaces/ContainerMemory#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ContainerMemory#pivot)

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-69]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/ContainerMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-70]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`pixivnId`](/pixi-vn/index/interfaces/ContainerMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-71]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`position`](/pixi-vn/index/interfaces/ContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-72]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ContainerMemory#rotation)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-74]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`scale`](/pixi-vn/index/interfaces/ContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-75]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-76]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`skew`](/pixi-vn/index/interfaces/ContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-77]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-78]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-79]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`tabIndex`](/pixi-vn/index/interfaces/ContainerMemory#tabindex)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-80]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`tint`](/pixi-vn/index/interfaces/ContainerMemory#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-81]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`visible`](/pixi-vn/index/interfaces/ContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-82]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-83]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`x`](/pixi-vn/index/interfaces/ContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-84]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`xAlign`](/pixi-vn/index/interfaces/ContainerMemory#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-85]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`y`](/pixi-vn/index/interfaces/ContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-86]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`yAlign`](/pixi-vn/index/interfaces/ContainerMemory#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-87]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: ImageContainerOptions<C> (/pixi-vn/index/interfaces/ImageContainerOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L20)

## Extends [#extends]

* [`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions)\<`C`>

## Type Parameters [#type-parameters]

### C [#c]

`C` *extends* [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild) = [`ContainerChild`](/pixi-vn/index/type-aliases/ContainerChild)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessible`](/pixi-vn/index/interfaces/ContainerOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessibleChildren`](/pixi-vn/index/interfaces/ContainerOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessibleHint`](/pixi-vn/index/interfaces/ContainerOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/ContainerOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessibleText`](/pixi-vn/index/interfaces/ContainerOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessibleTitle`](/pixi-vn/index/interfaces/ContainerOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`accessibleType`](/pixi-vn/index/interfaces/ContainerOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`align`](/pixi-vn/index/interfaces/ContainerOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: [src/canvas/components/AnchorExtension.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AnchorExtension.ts#L4)

#### Inherited from [#inherited-from-9]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`anchor`](/pixi-vn/index/interfaces/ContainerOptions#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-11]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-12]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-13]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-14]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`children`](/pixi-vn/index/interfaces/ContainerOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-15]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`cullable`](/pixi-vn/index/interfaces/ContainerOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-16]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`cullableChildren`](/pixi-vn/index/interfaces/ContainerOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-17]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`cullArea`](/pixi-vn/index/interfaces/ContainerOptions#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-18]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-19]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-20]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-22]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-28]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-49]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-61]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-62]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-63]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`percentagePosition`](/pixi-vn/index/interfaces/ContainerOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`percentageX`](/pixi-vn/index/interfaces/ContainerOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`percentageY`](/pixi-vn/index/interfaces/ContainerOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-66]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-71]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-74]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-75]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`tabIndex`](/pixi-vn/index/interfaces/ContainerOptions#tabindex)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-76]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`tint`](/pixi-vn/index/interfaces/ContainerOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-77]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-78]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-79]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-80]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`xAlign`](/pixi-vn/index/interfaces/ContainerOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-81]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-82]

[`ContainerOptions`](/pixi-vn/index/interfaces/ContainerOptions).[`yAlign`](/pixi-vn/index/interfaces/ContainerOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-83]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: ImageSpriteMemory (/pixi-vn/index/interfaces/ImageSpriteMemory)



Defined in: [src/canvas/interfaces/memory/ImageSpriteMemory.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageSpriteMemory.ts#L6)

The memory of the image. It uses for save the state of the image.

## Extends [#extends]

* [`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory)

## Extended by [#extended-by]

* [`VideoSpriteMemory`](/pixi-vn/index/interfaces/VideoSpriteMemory)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessible`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleHint`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleText`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleTitle`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleType`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`align`](/pixi-vn/index/interfaces/SpriteBaseMemory#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`alpha`](/pixi-vn/index/interfaces/SpriteBaseMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

`ImageSpriteMemory`.[`anchor`](#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`angle`](/pixi-vn/index/interfaces/SpriteBaseMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/SpriteBaseMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`blendMode`](/pixi-vn/index/interfaces/SpriteBaseMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`boundsArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/SpriteBaseMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`children`](/pixi-vn/index/interfaces/SpriteBaseMemory#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullable`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullableChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cursor`](/pixi-vn/index/interfaces/SpriteBaseMemory#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`eventMode`](/pixi-vn/index/interfaces/SpriteBaseMemory#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`filters`](/pixi-vn/index/interfaces/SpriteBaseMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`height`](/pixi-vn/index/interfaces/SpriteBaseMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`hitArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#hitarea)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`index`](/pixi-vn/index/interfaces/SpriteBaseMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`interactive`](/pixi-vn/index/interfaces/SpriteBaseMemory#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`interactiveChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/SpriteBaseMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`label`](/pixi-vn/index/interfaces/SpriteBaseMemory#label)

***

### loadIsStarted [#loadisstarted]

\> **loadIsStarted**: `boolean`

Defined in: [src/canvas/interfaces/memory/ImageSpriteMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageSpriteMemory.ts#L7)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`mask`](/pixi-vn/index/interfaces/SpriteBaseMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onclick`](/pixi-vn/index/interfaces/SpriteBaseMemory#onclick)

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-30]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onEvents`](/pixi-vn/index/interfaces/SpriteBaseMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobalmousemove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobalpointermove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-33]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobaltouchmove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmousedown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseenter`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseleave`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmousemove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseout`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseover`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointercancel`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerdown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerenter`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerleave`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointermove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerout`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerover`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointertap`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-52]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onRender`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightclick`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightdown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontap`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchcancel`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchend`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchendoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchmove`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchstart`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onwheel`](/pixi-vn/index/interfaces/SpriteBaseMemory#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-64]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-65]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-66]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`parentLabel`](/pixi-vn/index/interfaces/SpriteBaseMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentagePosition`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentageX`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentageY`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-70]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pivot`](/pixi-vn/index/interfaces/SpriteBaseMemory#pivot)

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-71]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/SpriteBaseMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-72]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pixivnId`](/pixi-vn/index/interfaces/SpriteBaseMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-73]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`position`](/pixi-vn/index/interfaces/SpriteBaseMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-74]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`renderable`](/pixi-vn/index/interfaces/SpriteBaseMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-75]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`rotation`](/pixi-vn/index/interfaces/SpriteBaseMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-76]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`roundPixels`](/pixi-vn/index/interfaces/SpriteBaseMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-77]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`scale`](/pixi-vn/index/interfaces/SpriteBaseMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-78]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`setMask`](/pixi-vn/index/interfaces/SpriteBaseMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-79]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`skew`](/pixi-vn/index/interfaces/SpriteBaseMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-80]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`sortableChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-81]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`sortDirty`](/pixi-vn/index/interfaces/SpriteBaseMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-82]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`tabIndex`](/pixi-vn/index/interfaces/SpriteBaseMemory#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-83]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`texture`](/pixi-vn/index/interfaces/SpriteBaseMemory#texture)

***

### textureData? [#texturedata]

> `optional` **textureData?**: [`AssetMemory`](/pixi-vn/index/interfaces/AssetMemory)

Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L12)

#### Inherited from [#inherited-from-84]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`textureData`](/pixi-vn/index/interfaces/SpriteBaseMemory#texturedata)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-85]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`tint`](/pixi-vn/index/interfaces/SpriteBaseMemory#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-86]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`visible`](/pixi-vn/index/interfaces/SpriteBaseMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-87]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`width`](/pixi-vn/index/interfaces/SpriteBaseMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-88]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`x`](/pixi-vn/index/interfaces/SpriteBaseMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-89]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`xAlign`](/pixi-vn/index/interfaces/SpriteBaseMemory#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-90]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`y`](/pixi-vn/index/interfaces/SpriteBaseMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-91]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`yAlign`](/pixi-vn/index/interfaces/SpriteBaseMemory#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-92]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`zIndex`](/pixi-vn/index/interfaces/SpriteBaseMemory#zindex)


# Interface: ImageSpriteOptions (/pixi-vn/index/interfaces/ImageSpriteOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L22)

## Extends [#extends]

* [`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions)

## Extended by [#extended-by]

* [`VideoSpriteOptions`](/pixi-vn/index/interfaces/VideoSpriteOptions)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessible`](/pixi-vn/index/interfaces/SpriteOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessibleChildren`](/pixi-vn/index/interfaces/SpriteOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessibleHint`](/pixi-vn/index/interfaces/SpriteOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/SpriteOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessibleText`](/pixi-vn/index/interfaces/SpriteOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessibleTitle`](/pixi-vn/index/interfaces/SpriteOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`accessibleType`](/pixi-vn/index/interfaces/SpriteOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`align`](/pixi-vn/index/interfaces/SpriteOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`anchor`](/pixi-vn/index/interfaces/ImageSpriteMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/ImageSpriteMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`children`](/pixi-vn/index/interfaces/SpriteOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`cullable`](/pixi-vn/index/interfaces/SpriteOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`cullableChildren`](/pixi-vn/index/interfaces/SpriteOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`cullArea`](/pixi-vn/index/interfaces/SpriteOptions#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-25]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-26]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-63]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`percentagePosition`](/pixi-vn/index/interfaces/SpriteOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`percentageX`](/pixi-vn/index/interfaces/SpriteOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`percentageY`](/pixi-vn/index/interfaces/SpriteOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-71]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`roundPixels`](/pixi-vn/index/interfaces/ImageSpriteMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-74]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-75]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-76]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-77]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`tabIndex`](/pixi-vn/index/interfaces/SpriteOptions#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-78]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`texture`](/pixi-vn/index/interfaces/ImageSpriteMemory#texture)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-79]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`tint`](/pixi-vn/index/interfaces/SpriteOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-80]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-81]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-82]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-83]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`xAlign`](/pixi-vn/index/interfaces/SpriteOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-84]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`SpriteOptions`](/pixi-vn/index/interfaces/SpriteOptions).[`yAlign`](/pixi-vn/index/interfaces/SpriteOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-86]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: IrisInOutProps (/pixi-vn/index/interfaces/IrisInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L76)

Shared options for the mask-based reveal/conceal transitions ([WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps),
IrisInOutProps, [SplitInOutProps](/pixi-vn/index/interfaces/SplitInOutProps)).

## Extends [#extends]

* [`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`MaskTransitionProps.aliasToRemoveAfter`

***

### aspect? [#aspect]

\> `optional` **aspect?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L86)

The aspect ratio (width / height) of the iris shape. `1` (the default) is a circle.

#### Default [#default-1]

```ts
1
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/MaskTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounce`](/pixi-vn/index/interfaces/MaskTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/MaskTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`damping`](/pixi-vn/index/interfaces/MaskTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delay`](/pixi-vn/index/interfaces/MaskTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`driver`](/pixi-vn/index/interfaces/MaskTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`duration`](/pixi-vn/index/interfaces/MaskTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`ease`](/pixi-vn/index/interfaces/MaskTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/MaskTransitionProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`from`](/pixi-vn/index/interfaces/MaskTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`inherit`](/pixi-vn/index/interfaces/MaskTransitionProps#inherit)

***

### invert? [#invert]

\> `optional` **invert?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L59)

If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.

#### Default [#default-4]

```ts
false
```

#### Inherited from [#inherited-from-15]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`invert`](/pixi-vn/index/interfaces/MaskTransitionProps#invert)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`isSync`](/pixi-vn/index/interfaces/MaskTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`mass`](/pixi-vn/index/interfaces/MaskTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`max`](/pixi-vn/index/interfaces/MaskTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`min`](/pixi-vn/index/interfaces/MaskTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/MaskTransitionProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `Partial`\<`PointData`>

Defined in: [src/canvas/interfaces/transition-props.ts:81](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L81)

The origin of the iris, normalized to the component's own bounds (`0` to `1` on each axis).

#### Default [#default-6]

```ts
{ x: 0.5, y: 0.5 }
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`path`](/pixi-vn/index/interfaces/MaskTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`power`](/pixi-vn/index/interfaces/MaskTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/MaskTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeat`](/pixi-vn/index/interfaces/MaskTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/MaskTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/MaskTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/MaskTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/MaskTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/MaskTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`startTime`](/pixi-vn/index/interfaces/MaskTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`MaskTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`MaskTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/MaskTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`times`](/pixi-vn/index/interfaces/MaskTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`type`](/pixi-vn/index/interfaces/MaskTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`velocity`](/pixi-vn/index/interfaces/MaskTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/MaskTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`when`](/pixi-vn/index/interfaces/MaskTransitionProps#when)


# Interface: LabelProps<T, StepIdType> (/pixi-vn/index/interfaces/LabelProps)



Defined in: [src/narration/interfaces/LabelProps.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/LabelProps.ts#L3)

## Type Parameters [#type-parameters]

### T [#t]

`T`

### StepIdType [#stepidtype]

`StepIdType` = `number`

## Properties [#properties]

### onLoadingLabel? [#onloadinglabel]

\> `optional` **onLoadingLabel?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/interfaces/LabelProps.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/LabelProps.ts#L44)

Is a function that will be executed in [onStepStart](#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narration.openedLabels](/pixi-vn/index/interfaces/NarrationManagerInterface#openedlabels).
It is useful for example to make sure all images used have been cached

#### Parameters [#parameters]

##### stepId [#stepid]

`StepIdType`

The index of the `step` being executed

##### label [#label]

`T`

The `label` being executed

#### Returns [#returns]

`void` | `Promise`\<`void`>

#### Example [#example]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

***

### onStepEnd? [#onstepend]

\> `optional` **onStepEnd?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/interfaces/LabelProps.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/LabelProps.ts#L65)

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

#### Parameters [#parameters-1]

##### stepId [#stepid-1]

`StepIdType`

The index of the `step` that ended

##### label [#label-1]

`T`

The `label` containing the `step`

#### Returns [#returns-1]

`void` | `Promise`\<`void`>

#### Example [#example-1]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

***

### onStepStart? [#onstepstart]

\> `optional` **onStepStart?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/interfaces/LabelProps.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/LabelProps.ts#L25)

A function executed before each `step`.

#### Parameters [#parameters-2]

##### stepId [#stepid-2]

`StepIdType`

The index of the `step` being executed

##### label [#label-2]

`T`

The `label` containing the `step`

#### Returns [#returns-2]

`void` | `Promise`\<`void`>

#### Example [#example-2]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```


# Interface: ListenerExtension (/pixi-vn/index/interfaces/ListenerExtension)



Defined in: [src/canvas/components/ListenerExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L13)

## Properties [#properties]

### on [#on]

\> **on**: \<`T`>(`event`, `fn`, `context?`) => `this`

Defined in: [src/canvas/components/ListenerExtension.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L28)

Add a listener for a given event.

Add a listener for a given event.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns]

`this`

#### Example [#example]

```ts
export class Events {
    \@eventDecorator()
    static eventExample(event: FederatedEvent, component: Sprite) {
        // event code here
    }
}

sprite.on("pointerdown", Events.eventExample);
```

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L29)


# Interface: ListenerExtensionMemory (/pixi-vn/index/interfaces/ListenerExtensionMemory)



Defined in: [src/canvas/components/ListenerExtension.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L5)

## Extended by [#extended-by]

* [`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory)
* [`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory)
* [`TextMemory`](/pixi-vn/index/interfaces/TextMemory)

## Properties [#properties]

### onEvents? [#onevents]

\> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)


# Interface: MaskTransitionProps (/pixi-vn/index/interfaces/MaskTransitionProps)



Defined in: [src/canvas/interfaces/transition-props.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L54)

Shared options for the mask-based reveal/conceal transitions ([WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps),
[IrisInOutProps](/pixi-vn/index/interfaces/IrisInOutProps), [SplitInOutProps](/pixi-vn/index/interfaces/SplitInOutProps)).

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Extended by [#extended-by]

* [`IrisInOutProps`](/pixi-vn/index/interfaces/IrisInOutProps)
* [`SplitInOutProps`](/pixi-vn/index/interfaces/SplitInOutProps)
* [`WipeInOutProps`](/pixi-vn/index/interfaces/WipeInOutProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### invert? [#invert]

\> `optional` **invert?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L59)

If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.

#### Default [#default-3]

```ts
false
```

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: MediaInterface (/pixi-vn/index/interfaces/MediaInterface)



Defined in: [src/sound/interfaces/MediaInterface.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/MediaInterface.ts#L3)

## Extends [#extends]

* `Pick`\<`Player`, `"blockTime"` | `"disposed"` | `"loaded"` | `"loop"` | `"loopEnd"` | `"loopStart"` | `"mute"` | `"now"` | `"playbackRate"` | `"reverse"` | `"restart"` | `"start"` | `"stop"` | `"chain"` | `"disconnect"` | `"volume"` | `"state"`>

## Properties [#properties]

### blockTime [#blocktime]

\> **blockTime**: `number`

Defined in: node_modules/tone/build/esm/core/context/ToneWithContext.d.ts:57

#### Inherited from [#inherited-from]

`Pick.blockTime`

***

### disposed [#disposed]

\> **disposed**: `boolean`

Defined in: node_modules/tone/build/esm/core/Tone.d.ts:52

#### Inherited from [#inherited-from-1]

`Pick.disposed`

***

### loaded [#loaded]

\> **loaded**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:189

#### Inherited from [#inherited-from-2]

`Pick.loaded`

***

### loop [#loop]

\> **loop**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:163

#### Inherited from [#inherited-from-3]

`Pick.loop`

***

### loopEnd [#loopend]

\> **loopEnd**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:149

#### Inherited from [#inherited-from-4]

`Pick.loopEnd`

***

### loopStart [#loopstart]

\> **loopStart**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:144

#### Inherited from [#inherited-from-5]

`Pick.loopStart`

***

### mute [#mute]

\> **mute**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:97

#### Inherited from [#inherited-from-6]

`Pick.mute`

***

### ~~muted~~ [#muted]

\> **muted**: `boolean`

Defined in: [src/sound/interfaces/MediaInterface.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/MediaInterface.ts#L31)

#### Deprecated [#deprecated]

Use [mute](#mute) instead.

***

### paused [#paused]

\> **paused**: `boolean`

Defined in: [src/sound/interfaces/MediaInterface.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/MediaInterface.ts#L27)

Whether the sound is currently paused.

***

### playbackRate [#playbackrate]

\> **playbackRate**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:174

#### Inherited from [#inherited-from-7]

`Pick.playbackRate`

***

### reverse [#reverse]

\> **reverse**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:184

#### Inherited from [#inherited-from-8]

`Pick.reverse`

***

### ~~speed~~ [#speed]

\> **speed**: `number`

Defined in: [src/sound/interfaces/MediaInterface.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/MediaInterface.ts#L35)

#### Deprecated [#deprecated-1]

Use [playbackRate](#playbackrate) instead.

***

### state [#state]

\> **state**: `BasicPlaybackState`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:89

#### Inherited from [#inherited-from-9]

`Pick.state`

***

### volume [#volume]

\> **volume**: `Param`\<`"decibels"`>

Defined in: node_modules/tone/build/esm/source/Source.d.ts:49

The volume of the output in decibels.

#### Example [#example]

```ts
const source = new Tone.PWMOscillator().toDestination();
source.volume.value = -6;
```

#### Inherited from [#inherited-from-10]

`Pick.volume`

## Methods [#methods]

### chain() [#chain]

\> **chain**(...`nodes`): `this`

Defined in: node_modules/tone/build/esm/core/context/ToneAudioNode.d.ts:125

Connect the output of this node to the rest of the nodes in series.

#### Parameters [#parameters]

##### nodes [#nodes]

...`InputNode`\[]

#### Returns [#returns]

`this`

#### Example [#example-1]

```ts
const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
player.autostart = true;
const filter = new Tone.AutoFilter(4).start();
const distortion = new Tone.Distortion(0.5);
// connect the player to the filter, distortion and then to the master output
player.chain(filter, distortion, Tone.Destination);
```

#### Inherited from [#inherited-from-11]

`Pick.chain`

***

### disconnect() [#disconnect]

\> **disconnect**(`destination?`, `outputNum?`, `inputNum?`): `this`

Defined in: node_modules/tone/build/esm/core/context/ToneAudioNode.d.ts:114

disconnect the output

#### Parameters [#parameters-1]

##### destination? [#destination]

`InputNode`

##### outputNum? [#outputnum]

`number`

##### inputNum? [#inputnum]

`number`

#### Returns [#returns-1]

`this`

#### Inherited from [#inherited-from-12]

`Pick.disconnect`

***

### now() [#now]

\> **now**(): `number`

Defined in: node_modules/tone/build/esm/core/context/ToneWithContext.d.ts:39

Return the current time of the Context clock plus the lookAhead.

#### Returns [#returns-2]

`number`

#### Example [#example-2]

```ts
setInterval(() => {
	console.log(Tone.now());
}, 100);
```

#### Inherited from [#inherited-from-13]

`Pick.now`

***

### restart() [#restart]

\> **restart**(`time?`, `offset?`, `duration?`): `this`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:114

Stop and then restart the player from the beginning (or offset)

#### Parameters [#parameters-2]

##### time? [#time]

`number`

When the player should start.

##### offset? [#offset]

`Time`

The offset from the beginning of the sample to start at.

##### duration? [#duration]

`Time`

How long the sample should play. If no duration is given,
it will default to the full length of the sample (minus any offset)

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-14]

`Pick.restart`

***

### start() [#start]

\> **start**(`time?`, `offset?`, `duration?`): `this`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:98

Play the buffer at the given startTime. Optionally add an offset
and/or duration which will play the buffer from a position
within the buffer for the given duration.

#### Parameters [#parameters-3]

##### time? [#time-1]

`Time`

When the player should start.

##### offset? [#offset-1]

`Time`

The offset from the beginning of the sample to start at.

##### duration? [#duration-1]

`Time`

How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)

#### Returns [#returns-4]

`this`

#### Inherited from [#inherited-from-15]

`Pick.start`

***

### stop() [#stop]

\> **stop**(`time?`): `this`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:125

Stop the source at the specified time. If no time is given,
stop the source now.

#### Parameters [#parameters-4]

##### time? [#time-2]

`Time`

When the source should be stopped.

#### Returns [#returns-5]

`this`

#### Example [#example-3]

```ts
const source = new Tone.Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
```

#### Inherited from [#inherited-from-16]

`Pick.stop`


# Interface: MoveInOutProps (/pixi-vn/index/interfaces/MoveInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L16)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/transition-props.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L21)

The direction of the movement.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### motionBlur? [#motionblur]

\> `optional` **motionBlur?**: `number` | `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L27)

Adds a motion-blur trail along the movement, ramping up mid-move and back to sharp at the end.
`true` uses a 40px trail; a number sets the trail length (pixels).

#### Default [#default-5]

```ts
false
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: NarrationChoicesInterface (/pixi-vn/index/interfaces/NarrationChoicesInterface)



Defined in: [src/narration/interfaces/NarrationChoicesInterface.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationChoicesInterface.ts#L5)

## Accessors [#accessors]

### list [#list]

#### Get Signature [#get-signature]

\> **get** **list**(): [`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)\[] | `undefined`

Defined in: [src/narration/interfaces/NarrationChoicesInterface.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationChoicesInterface.ts#L9)

The choices to be shown in the game.

##### Returns [#returns]

[`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)\[] | `undefined`

#### Set Signature [#set-signature]

\> **set** **list**(`data`): `void`

Defined in: [src/narration/interfaces/NarrationChoicesInterface.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationChoicesInterface.ts#L14)

The choices to be shown in the game.

##### Throws [#throws]

when a choice contains functions or class instances that cannot be serialized to JSON.

##### Parameters [#parameters]

###### data [#data]

[`StoredChoiceInterface`](/pixi-vn/index/type-aliases/StoredChoiceInterface)\[] | `undefined`

##### Returns [#returns-1]

`void`

## Methods [#methods]

### select() [#select]

\> **select**\<`T`>(`item`, `props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/interfaces/NarrationChoicesInterface.ts:36](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationChoicesInterface.ts#L36)

Select a choice from the choice menu, and close the choice menu.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `object`

#### Parameters [#parameters-1]

##### item [#item]

[`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)

The choice item selected by the player.

##### props [#props]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

The props to pass to the label.

#### Returns [#returns-2]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

StepLabelResultType or undefined.

#### Throws [#throws-1]

when the choice type is not `"call"`, `"jump"`, or `"close"`.

#### Example [#example]

```ts
narration.choices.select(item, {
    navigate: navigate,
    // your props
    ...item.props
})
    .then(() => {
        // your code
    })
    .catch((e) => {
        // your code
    })
```


# Interface: NarrationGameState (/pixi-vn/index/interfaces/NarrationGameState)



Defined in: [src/narration/interfaces/NarrationGameState.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationGameState.ts#L6)

Interface exported step data

## Properties [#properties]

### openedLabels [#openedlabels]

\> **openedLabels**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/interfaces/NarrationGameState.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationGameState.ts#L7)

***

### stepCounter [#stepcounter]

\> **stepCounter**: `number`

Defined in: [src/narration/interfaces/NarrationGameState.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationGameState.ts#L8)


# Interface: NarrationHistory (/pixi-vn/index/interfaces/NarrationHistory)



Defined in: [src/narration/interfaces/NarrationHistory.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L4)

## Properties [#properties]

### choices? [#choices]

\> `optional` **choices?**: [`HistoryChoiceMenuOption`](/pixi-vn/index/type-aliases/HistoryChoiceMenuOption)\[]

Defined in: [src/narration/interfaces/NarrationHistory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L12)

List of choices asked of the player

***

### dialogue? [#dialogue]

\> `optional` **dialogue?**: [`DialogueInterface`](/pixi-vn/index/interfaces/DialogueInterface)

Defined in: [src/narration/interfaces/NarrationHistory.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L8)

Dialogue to be shown in the game

***

### inputValue? [#inputvalue]

\> `optional` **inputValue?**: [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

Defined in: [src/narration/interfaces/NarrationHistory.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L24)

The input value of the player

***

### openedLabelsNumber? [#openedlabelsnumber]

\> `optional` **openedLabelsNumber?**: `number`

Defined in: [src/narration/interfaces/NarrationHistory.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L33)

The number of labels that were opened (via [NarrationManagerInterface.call](/pixi-vn/index/interfaces/NarrationManagerInterface#call) or [NarrationManagerInterface.jump](/pixi-vn/index/interfaces/NarrationManagerInterface#jump)) when this step ran.

This is the size of the label call-stack at this step, and can be used to split a page into paragraphs:
every time this number increases compared to the previous step, a `call` opened a new paragraph. A `jump`
instead starts a whole new page, so it is already reflected by [HistoryManagerInterface.currentLabelHistory](/pixi-vn/index/interfaces/HistoryManagerInterface#currentlabelhistory)
starting over.

***

### playerMadeChoice? [#playermadechoice]

\> `optional` **playerMadeChoice?**: `boolean`

Defined in: [src/narration/interfaces/NarrationHistory.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L16)

The player made a choice

***

### stepIndex [#stepindex]

\> **stepIndex**: `number`

Defined in: [src/narration/interfaces/NarrationHistory.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationHistory.ts#L20)

The index of the step in the history.


# Interface: NarrationInputInterface (/pixi-vn/index/interfaces/NarrationInputInterface)



Defined in: [src/narration/interfaces/NarrationInputInterface.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L4)

## Properties [#properties]

### isRequired [#isrequired]

\> `readonly` **isRequired**: `boolean`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L12)

If true, the player must enter a value.

***

### type [#type]

\> `readonly` **type**: `string` | `undefined`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L16)

Returns the type of input prompt requested.

***

### value [#value]

\> **value**: [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L8)

The input value to be inserted by the player.

## Methods [#methods]

### removeRequest() [#removerequest]

\> **removeRequest**(): `void`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L26)

Remove the input request.

#### Returns [#returns]

`void`

***

### request() [#request]

\> **request**(`info?`, `defaultValue?`): `void`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationInputInterface.ts#L22)

Returns `true` if the player must enter a value.

#### Parameters [#parameters]

##### info? [#info]

`Omit`\<[`InputInfo`](/pixi-vn/index/type-aliases/InputInfo), `"isRequired"`>

The input value to be inserted by the player.

##### defaultValue? [#defaultvalue]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The default value to be inserted.

#### Returns [#returns-1]

`void`


# Interface: NarrationLabelsInterface (/pixi-vn/index/interfaces/NarrationLabelsInterface)



Defined in: [src/narration/interfaces/NarrationLabelsInterface.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationLabelsInterface.ts#L3)

## Properties [#properties]

### current [#current]

\> `readonly` **current**: [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`> | `undefined`

Defined in: [src/narration/interfaces/NarrationLabelsInterface.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationLabelsInterface.ts#L11)

currentLabel is the current label that occurred during the progression of the steps.

***

### opened [#opened]

\> `readonly` **opened**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/interfaces/NarrationLabelsInterface.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationLabelsInterface.ts#L7)

The stack of the opened labels.

## Methods [#methods]

### closeAll() [#closeall]

\> **closeAll**(): `void`

Defined in: [src/narration/interfaces/NarrationLabelsInterface.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationLabelsInterface.ts#L19)

Close all labels and add them to the history. **Attention: This method can cause an unhandled game ending.**

#### Returns [#returns]

`void`

***

### closeCurrent() [#closecurrent]

\> **closeCurrent**(): `void`

Defined in: [src/narration/interfaces/NarrationLabelsInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationLabelsInterface.ts#L15)

Close the current label and add it to the history.

#### Returns [#returns-1]

`void`


# Interface: NarrationManagerInterface (/pixi-vn/index/interfaces/NarrationManagerInterface)



Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L20)

## Properties [#properties]

### ~~alreadyCurrentStepMadeChoices~~ [#alreadycurrentstepmadechoices]

\> `readonly` **alreadyCurrentStepMadeChoices**: `number`\[] | `undefined`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:92](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L92)

Get the choices already made in the current step. **Attention**: if the choice step index is edited or the code of choice step is edited, the result will be wrong.

#### Returns [#returns]

The choices already made in the current step. If there are no choices, it will return undefined.

#### Deprecated [#deprecated]

Use [queries](#queries).alreadyCurrentStepMadeChoices instead.

***

### canContinue [#cancontinue]

\> `readonly` **canContinue**: `boolean`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:139](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L139)

Return if can go to the next step. It's `false` when:

* A `step` is running
* The player must "make a choice"
* The player must "enter a value"

#### Returns [#returns-1]

True if can go to the next step.

***

### continue [#continue]

\> **continue**: (`props`, `options?`) => `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:165](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L165)

Execute the next step and add it to the history. If a step is already running, it will put the request in the queue,
and when the step is finished, it will execute the next step.

#### Parameters [#parameters]

##### props [#props]

`StepLabelProps`

The props to pass to the step.

##### options? [#options]

The options.

###### runNow? [#runnow]

`boolean`

If true, ignore the running step, ignore the choice menu/required input and run the next step immediately.

###### steps? [#steps]

`number`

The number of steps to advance. Must be a valid finite number greater than 0.
If NaN, Infinity, or a value less than or equal to 0 is provided, the implementation
will emit a warning and return early without advancing steps.

**Default**

```ts
1
```

#### Returns [#returns-2]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

StepLabelResultType or undefined.

#### Example [#example]

```ts
    function nextOnClick() {
    setLoading(true)
    narration.continue(yourParams)
        .then((result) => {
            setUpdate((p) => p + 1)
            setLoading(false)
            if (result) {
                // your code
            }
        })
        .catch((e) => {
            setLoading(false)
            console.error(e)
        })
}
```

***

### ~~currentLabel~~ [#currentlabel]

\> `readonly` **currentLabel**: [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`> | `undefined`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:65](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L65)

currentLabel is the current label that occurred during the progression of the steps.

#### Deprecated [#deprecated-1]

Use [labels](#labels).current instead.

***

### currentStepTimesCounter [#currentsteptimescounter]

\> **currentStepTimesCounter**: `number`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L31)

Counter of execution times of the current step. Current execution is also included. Starts from 1.

**Attention**: if the step index is edited or the code of step is edited, the counter will be reset.

You can restart the counter in this way:

```ts
narration.currentStepTimesCounter = 0
```

***

### dialogGlue [#dialogglue]

\> **dialogGlue**: `boolean`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:294](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L294)

If true, the next dialogue text will be added to the current dialogue text.

***

### input [#input]

\> `readonly` **input**: [`NarrationInputInterface`](/pixi-vn/index/interfaces/NarrationInputInterface)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:120](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L120)

Namespace for operations on the input requested to the player.

***

### ~~inputType~~ [#inputtype]

\> `readonly` **inputType**: `string` | `undefined`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L309)

Returns the type of input prompt requested.

#### Deprecated [#deprecated-2]

Use [input](#input).type instead.

***

### ~~inputValue~~ [#inputvalue]

\> **inputValue**: [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:299](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L299)

The input value to be inserted by the player.

#### Deprecated [#deprecated-3]

Use [input](#input).value instead.

***

### ~~isCurrentStepAlreadyOpened~~ [#iscurrentstepalreadyopened]

\> `readonly` **isCurrentStepAlreadyOpened**: `boolean`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L98)

Check if the current step is already completed.

#### Returns [#returns-3]

True if the current step is already completed.

#### Deprecated [#deprecated-4]

Use [queries](#queries).isCurrentStepAlreadyOpened instead.

***

### ~~isRequiredInput~~ [#isrequiredinput]

\> `readonly` **isRequiredInput**: `boolean`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L304)

If true, the player must enter a value.

#### Deprecated [#deprecated-5]

Use [input](#input).isRequired instead.

***

### labels [#labels]

\> `readonly` **labels**: [`NarrationLabelsInterface`](/pixi-vn/index/interfaces/NarrationLabelsInterface)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:124](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L124)

Namespace for operations on the opened labels.

***

### ~~openedLabels~~ [#openedlabels]

\> `readonly` **openedLabels**: [`OpenedLabel`](/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:60](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L60)

The stack of the opened labels.

#### Deprecated [#deprecated-6]

Use [labels](#labels).opened instead.

***

### queries [#queries]

\> `readonly` **queries**: [`NarrationQueriesInterface`](/pixi-vn/index/interfaces/NarrationQueriesInterface)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:128](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L128)

Namespace for queries about the current state of the narration.

***

### stepCounter [#stepcounter]

\> `readonly` **stepCounter**: `number`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L55)

This counter corresponds to the total number of steps that have been executed so far.

**Not is the history.stepsHistory.length - 1.**

## Accessors [#accessors]

### choices [#choices]

#### Get Signature [#get-signature]

\> **get** **choices**(): [`NarrationChoicesInterface`](/pixi-vn/index/interfaces/NarrationChoicesInterface)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:275](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L275)

Namespace for operations on the choices to be shown in the game.

##### Returns [#returns-4]

[`NarrationChoicesInterface`](/pixi-vn/index/interfaces/NarrationChoicesInterface)

#### Set Signature [#set-signature]

\> **set** **choices**(`data`): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:290](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L290)

Shortcut for [NarrationChoicesInterface.list](/pixi-vn/index/interfaces/NarrationChoicesInterface#list).

##### Throws [#throws]

when a choice contains functions or class instances that cannot be serialized to JSON.

##### Example [#example-1]

```ts
narration.choices = [
    newChoiceOption("Events Test", EventsTestLabel, {}),
    newChoiceOption("Show Image Test", ShowImageTest, { image: "imageId" }, "call"),
    newChoiceOption("Ticker Test", TickerTestLabel, {}),
    newChoiceOption("Tinting Test", TintingTestLabel, {}, "jump"),
    newChoiceOption("Base Canvas Element Test", BaseCanvasElementTestLabel, {})
]
```

##### Parameters [#parameters-1]

###### data [#data]

[`StoredChoiceInterface`](/pixi-vn/index/type-aliases/StoredChoiceInterface)\[] | `undefined`

##### Returns [#returns-5]

`void`

***

### dialogue [#dialogue]

#### Get Signature [#get-signature-1]

\> **get** **dialogue**(): [`DialogueInterface`](/pixi-vn/index/interfaces/DialogueInterface) | `undefined`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:266](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L266)

Dialogue to be shown in the game

##### Returns [#returns-6]

[`DialogueInterface`](/pixi-vn/index/interfaces/DialogueInterface) | `undefined`

#### Set Signature [#set-signature-1]

\> **set** **dialogue**(`props`): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:271](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L271)

Dialogue to be shown in the game

##### Throws [#throws-1]

when the dialogue contains functions or class instances that cannot be serialized to JSON.

##### Parameters [#parameters-2]

###### props [#props-1]

`string` | `string`\[] | [`DialogueInterface`](/pixi-vn/index/interfaces/DialogueInterface) | `undefined`

##### Returns [#returns-7]

`void`

## Methods [#methods]

### addCurrentStepToHistory() [#addcurrentsteptohistory]

\> **addCurrentStepToHistory**(): `Promise`\<`void`>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:116](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L116)

Save the current step to the history.

#### Returns [#returns-8]

`Promise`\<`void`>

A promise that resolves once the history is saved and the step counter is updated.

***

### call() [#call]

\> **call**\<`T`>(`label`, `props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:202](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L202)

Execute the label, add the label to the history and execute the next step of the label.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `object` = \{ }

#### Parameters [#parameters-3]

##### label [#label]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

The label to execute or the id of the label

##### props [#props-2]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

The props to pass to the label.

#### Returns [#returns-9]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

StepLabelResultType or undefined.

#### Throws [#throws-2]

when the label is not found in the registered labels.

#### Examples [#examples]

```ts
narration.call(startLabel, yourParams).then((result) => {
    if (result) {
        // your code
    }
})
```

```ts
// if you use it in a step label you should return the result.
return narration.call(startLabel).then((result) => {
    return result
})
```

***

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:326](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L326)

Clear all narration data

#### Returns [#returns-10]

`void`

***

### ~~closeAllLabels()~~ [#closealllabels]

\> **closeAllLabels**(): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:79](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L79)

Close all labels and add them to the history. **Attention: This method can cause an unhandled game ending.**

#### Returns [#returns-11]

`void`

#### Deprecated [#deprecated-7]

Use [labels](#labels).closeAll instead.

***

### ~~closeCurrentLabel()~~ [#closecurrentlabel]

\> **closeCurrentLabel**(): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L74)

Close the current label and add it to the history.

#### Returns [#returns-12]

`void`

#### Deprecated [#deprecated-8]

Use [labels](#labels).closeCurrent instead.

***

### export() [#export]

\> **export**(): [`NarrationGameState`](/pixi-vn/index/interfaces/NarrationGameState)

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L334)

Export the narration to an object.

#### Returns [#returns-13]

[`NarrationGameState`](/pixi-vn/index/interfaces/NarrationGameState)

The narration in an object.

***

### getRandomNumber() [#getrandomnumber]

\> **getRandomNumber**(`min`, `max`, `options?`): `number` | `undefined`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:39](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L39)

Get a random number between min and max.

#### Parameters [#parameters-4]

##### min [#min]

`number`

The minimum number.

##### max [#max]

`number`

The maximum number.

##### options? [#options-1]

The options.

###### onceOnly? [#onceonly]

`boolean`

If `true`, the number will be generated only once for the current `step` of the `label` (default: `false`). Note: `min` and `max` affect the storage of already generated numbers.

**Default**

```ts
false
```

#### Returns [#returns-14]

`number` | `undefined`

The random number or undefined. If options.onceonly is true and all numbers between min and max have already been generated, it will return undefined.

***

### ~~getTimesChoiceMade()~~ [#gettimeschoicemade]

\> **getTimesChoiceMade**(`index`): `number`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:111](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L111)

Get times a choice has been made in the current step.

#### Parameters [#parameters-5]

##### index [#index]

`number`

The index of the choice.

#### Returns [#returns-15]

`number`

The number of times the choice has been made.

#### Deprecated [#deprecated-9]

Use [queries](#queries).timesChoiceMade instead.

***

### ~~getTimesLabelOpened()~~ [#gettimeslabelopened]

\> **getTimesLabelOpened**(`label`): `number`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:104](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L104)

Get times a label has been opened

#### Parameters [#parameters-6]

##### label [#label-1]

`string`

#### Returns [#returns-16]

`number`

times a label has been opened

#### Deprecated [#deprecated-10]

Use [queries](#queries).timesLabelOpened instead.

***

### ~~isLabelAlreadyCompleted()~~ [#islabelalreadycompleted]

\> **isLabelAlreadyCompleted**(`label`): `boolean`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L86)

Check if the label is already completed.

#### Parameters [#parameters-7]

##### label [#label-2]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`>

The label to check.

#### Returns [#returns-17]

`boolean`

True if the label is already completed.

#### Deprecated [#deprecated-11]

Use [queries](#queries).isLabelAlreadyCompleted instead.

***

### jump() [#jump]

\> **jump**\<`T`>(`label`, `props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:228](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L228)

Execute the label, replace the current label in the history with the new label and execute the next step of the label.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `object`

#### Parameters [#parameters-8]

##### label [#label-3]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

The label to execute.

##### props [#props-3]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

The props to pass to the label or the id of the label

#### Returns [#returns-18]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

StepLabelResultType or undefined.

#### Throws [#throws-3]

when the label is not found in the registered labels.

#### Examples [#examples-1]

```ts
narration.jump(startLabel, yourParams).then((result) => {
    if (result) {
        // your code
    }
})
```

```ts
// if you use it in a step label you should return the result.
return narration.jump(startLabel).then((result) => {
    return result
})
```

***

### ~~removeInputRequest()~~ [#removeinputrequest]

\> **removeInputRequest**(): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:321](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L321)

Remove the input request.

#### Returns [#returns-19]

`void`

#### Deprecated [#deprecated-12]

Use [input](#input).removeRequest instead.

***

### ~~requestInput()~~ [#requestinput]

\> **requestInput**(`info?`, `defaultValue?`): `void`

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:316](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L316)

Returns `true` if the player must enter a value.

#### Parameters [#parameters-9]

##### info? [#info]

`Omit`\<[`InputInfo`](/pixi-vn/index/type-aliases/InputInfo), `"isRequired"`>

The input value to be inserted by the player.

##### defaultValue? [#defaultvalue]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The default value to be inserted.

#### Returns [#returns-20]

`void`

#### Deprecated [#deprecated-13]

Use [input](#input).request instead.

***

### restore() [#restore]

\> **restore**(`data`, `lastHistoryStep`): `Promise`\<`void`>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:339](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L339)

Restore the narration from an object.

#### Parameters [#parameters-10]

##### data [#data-1]

`object`

The narration in an object.

##### lastHistoryStep [#lasthistorystep]

`Omit`\<[`HistoryStep`](/pixi-vn/index/interfaces/HistoryStep), `"diff"`> | `null`

#### Returns [#returns-21]

`Promise`\<`void`>

***

### ~~selectChoice()~~ [#selectchoice]

\> **selectChoice**\<`T`>(`item`, `props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/interfaces/NarrationManagerInterface.ts:254](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationManagerInterface.ts#L254)

Select a choice from the choice menu. and close the choice menu.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `object`

#### Parameters [#parameters-11]

##### item [#item]

[`StoredIndexedChoiceInterface`](/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)

##### props [#props-4]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

#### Returns [#returns-22]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

#### Throws [#throws-4]

when the choice type is not `"call"`, `"jump"`, or `"close"`.

#### Example [#example-2]

```ts
narration.selectChoice(item, {
    navigate: navigate,
    // your props
    ...item.props
})
    .then(() => {
        // your code
    })
    .catch((e) => {
        // your code
    })
```

#### Deprecated [#deprecated-14]

Use [choices](#choices).select instead.


# Interface: NarrationQueriesInterface (/pixi-vn/index/interfaces/NarrationQueriesInterface)



Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L4)

## Properties [#properties]

### alreadyCurrentStepMadeChoices [#alreadycurrentstepmadechoices]

\> `readonly` **alreadyCurrentStepMadeChoices**: `number`\[] | `undefined`

Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L15)

Get the choices already made in the current step. **Attention**: if the choice step index is edited or the code of choice step is edited, the result will be wrong.

#### Returns [#returns]

The choices already made in the current step. If there are no choices, it will return undefined.

***

### isCurrentStepAlreadyOpened [#iscurrentstepalreadyopened]

\> `readonly` **isCurrentStepAlreadyOpened**: `boolean`

Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L20)

Check if the current step is already completed.

#### Returns [#returns-1]

True if the current step is already completed.

## Methods [#methods]

### isLabelAlreadyCompleted() [#islabelalreadycompleted]

\> **isLabelAlreadyCompleted**(`label`): `boolean`

Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L10)

Check if the label is already completed.

#### Parameters [#parameters]

##### label [#label]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`>

The label to check.

#### Returns [#returns-2]

`boolean`

True if the label is already completed.

***

### timesChoiceMade() [#timeschoicemade]

\> **timesChoiceMade**(`index`): `number`

Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L32)

Get times a choice has been made in the current step.

#### Parameters [#parameters-1]

##### index [#index]

`number`

The index of the choice.

#### Returns [#returns-3]

`number`

The number of times the choice has been made.

***

### timesLabelOpened() [#timeslabelopened]

\> **timesLabelOpened**(`label`): `number`

Defined in: [src/narration/interfaces/NarrationQueriesInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/NarrationQueriesInterface.ts#L26)

Get times a label has been opened.

#### Parameters [#parameters-2]

##### label [#label-1]

`string`

The label to check.

#### Returns [#returns-4]

`number`

times a label has been opened.


# Interface: NodEffectProps (/pixi-vn/index/interfaces/NodEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:101](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L101)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), NodEffectProps, [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### axis? [#axis]

\> `optional` **axis?**: `"horizontal"` | `"vertical"`

Defined in: [src/canvas/interfaces/effect-props.ts:106](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L106)

The axis the component oscillates along.

#### Default [#default-1]

```ts
"horizontal"
```

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### distance? [#distance]

\> `optional` **distance?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:111](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L111)

The distance (in pixels) of the first, largest oscillation.

#### Default [#default-5]

```ts
15
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### repetitions? [#repetitions]

\> `optional` **repetitions?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:116](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L116)

The number of repetitions.

#### Default [#default-7]

```ts
3
```

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-8]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: NoiseDissolveInOutProps (/pixi-vn/index/interfaces/NoiseDissolveInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:256](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L256)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
NoiseDissolveInOutProps, [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### edge? [#edge]

\> `optional` **edge?**: `"hard"` | `"soft"`

Defined in: [src/canvas/interfaces/transition-props.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L262)

`"hard"`: the component appears/disappears in crisp noise-shaped blotches. `"soft"`: a cloudy,
gradual dissolve.

#### Default [#default-3]

```ts
"hard"
```

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### noiseScale? [#noisescale]

\> `optional` **noiseScale?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:267](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L267)

The scale of the noise pattern - higher values give smaller, more numerous blotches.

#### Default [#default-5]

```ts
8
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### seed? [#seed]

\> `optional` **seed?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:271](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L271)

Picks the noise pattern. Random by default, so every dissolve looks different.

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: OnEventsHandlers (/pixi-vn/index/interfaces/OnEventsHandlers)



Defined in: [src/canvas/components/ListenerExtension.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L9)

## Indexable [#indexable]

\> \[`name`: `string`]: `string`


# Interface: OpenedLabel (/pixi-vn/index/interfaces/OpenedLabel)



Defined in: [src/narration/interfaces/OpenedLabel.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/OpenedLabel.ts#L3)

## Properties [#properties]

### currentStepIndex [#currentstepindex]

\> **currentStepIndex**: `number`

Defined in: [src/narration/interfaces/OpenedLabel.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/OpenedLabel.ts#L5)

***

### label [#label]

\> **label**: `string`

Defined in: [src/narration/interfaces/OpenedLabel.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/OpenedLabel.ts#L4)


# Interface: PinchInOutProps (/pixi-vn/index/interfaces/PinchInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:290](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L290)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), PinchInOutProps).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### mode? [#mode]

\> `optional` **mode?**: `"pinch"` | `"bulge"`

Defined in: [src/canvas/interfaces/transition-props.ts:300](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L300)

`"pinch"`: sucked into/out of a point. `"bulge"`: puffed out from/into a point.

#### Default [#default-4]

```ts
"pinch"
```

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `Partial`\<`PointData`>

Defined in: [src/canvas/interfaces/transition-props.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L309)

The center of the deformation, normalized to the component's own bounds.

#### Default [#default-5]

```ts
{ x: 0.5, y: 0.5 }
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### radius? [#radius]

\> `optional` **radius?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L304)

The radius (pixels) of the deformation. Defaults to half the component's diagonal.

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:295](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L295)

How strong the deformation is, from `0` to `1` - where `pinchIn` starts and `pinchOut` ends.

#### Default [#default-7]

```ts
1
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: PixelateInOutProps (/pixi-vn/index/interfaces/PixelateInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:151](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L151)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:165](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L165)

Whether the component itself also briefly fades in (`pixelateIn`) or out (`pixelateOut`) alongside
the pixelation, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a
quarter of the effect's own duration, mirrored to the start of `pixelateIn` or the end of
`pixelateOut`. Off by default: pixelation itself already reads as a deliberate, blocky
appear/disappear, so a softening fade is less often wanted here than for blur/flash.

#### Default [#default-3]

```ts
false
```

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### pixelSize? [#pixelsize]

\> `optional` **pixelSize?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:156](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L156)

The pixel size the effect starts from (`pixelateIn`) or ends at (`pixelateOut`).

#### Default [#default-5]

```ts
32
```

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: PixivnAssetAliasIds (/pixi-vn/index/interfaces/PixivnAssetAliasIds)



Defined in: [src/canvas/types/AssetAliasIdType.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/AssetAliasIdType.ts#L26)

An empty interface that can be augmented via `declare module '@drincs/pixi-vn/canvas'`
to constrain the set of valid asset aliases to a known union of string literals.

When this interface has no keys (the default), [AssetAliasIdType](/pixi-vn/index/type-aliases/AssetAliasIdType) resolves to `string`,
preserving full backwards compatibility. Once you augment it, [AssetAliasIdType](/pixi-vn/index/type-aliases/AssetAliasIdType) becomes
the union of the declared keys and the compiler will reject any unknown asset alias.

The augmentation is typically written into an auto-generated declaration file by the
Vite plugin (see the `assetsManifest` option of `vitePluginPixivn`), but it can
also be written by hand.

## Example [#example]

```ts
// pixi-vn.gen.d.ts  (auto-generated — do not edit manually)
declare module "@drincs/pixi-vn/canvas" {
    interface PixivnAssetAliasIds {
        logo: never;
        hero: never;
    }
}
export {};
```


# Interface: PixivnBundleIds (/pixi-vn/index/interfaces/PixivnBundleIds)



Defined in: [src/canvas/types/BundleIdType.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/BundleIdType.ts#L26)

An empty interface that can be augmented via `declare module '@drincs/pixi-vn/canvas'`
to constrain the set of valid asset bundle names to a known union of string literals.

When this interface has no keys (the default), [BundleIdType](/pixi-vn/index/type-aliases/BundleIdType) resolves to `string`,
preserving full backwards compatibility. Once you augment it, [BundleIdType](/pixi-vn/index/type-aliases/BundleIdType) becomes
the union of the declared keys and the compiler will reject any unknown bundle name.

The augmentation is typically written into an auto-generated declaration file by the
Vite plugin (see the `assetsManifest` option of `vitePluginPixivn`), but it can
also be written by hand.

## Example [#example]

```ts
// pixi-vn.gen.d.ts  (auto-generated — do not edit manually)
declare module "@drincs/pixi-vn/canvas" {
    interface PixivnBundleIds {
        main: never;
        ui: never;
    }
}
export {};
```


# Interface: PixivnCharacterIds (/pixi-vn/index/interfaces/PixivnCharacterIds)



Defined in: [src/characters/types/CharacterIdType.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/types/CharacterIdType.ts#L26)

An empty interface that can be augmented via `declare module '@drincs/pixi-vn/characters'`
to constrain the set of valid character IDs to a known union of string literals.

When this interface has no keys (the default), [CharacterIdType](/pixi-vn/index/type-aliases/CharacterIdType) resolves to `string`,
preserving full backwards compatibility. Once you augment it, [CharacterIdType](/pixi-vn/index/type-aliases/CharacterIdType) becomes
the union of the declared keys and the compiler will reject any unknown character ID.

The augmentation is typically written into an auto-generated declaration file by the
Vite plugin (see the `typeFilePath` option of `vitePluginPixivn`), but it can
also be written by hand.

## Example [#example]

```ts
// pixi-vn.gen.d.ts  (auto-generated — do not edit manually)
declare module "@drincs/pixi-vn/characters" {
    interface PixivnCharacterIds {
        liam: never;
        emma: never;
    }
}
export {};
```


# Interface: PixivnLabelIds (/pixi-vn/index/interfaces/PixivnLabelIds)



Defined in: [src/narration/types/LabelIdType.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/LabelIdType.ts#L26)

An empty interface that can be augmented via `declare module '@drincs/pixi-vn/narration'`
to constrain the set of valid label IDs to a known union of string literals.

When this interface has no keys (the default), [LabelIdType](/pixi-vn/index/type-aliases/LabelIdType) resolves to `string`,
preserving full backwards compatibility. Once you augment it, [LabelIdType](/pixi-vn/index/type-aliases/LabelIdType) becomes
the union of the declared keys and the compiler will reject any unknown label ID.

The augmentation is typically written into an auto-generated declaration file by the
Vite plugin (see the `labelTypeFilePath` option of `vitePluginPixivn`), but it can
also be written by hand.

## Example [#example]

```ts
// pixi-vn.gen.d.ts  (auto-generated — do not edit manually)
declare module "@drincs/pixi-vn/narration" {
    interface PixivnLabelIds {
        startLabel: never;
        menuLabel: never;
    }
}
export {};
```


# Interface: PulseEffectProps (/pixi-vn/index/interfaces/PulseEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L56)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### pulses? [#pulses]

\> `optional` **pulses?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:67](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L67)

The number of pulses.

#### Default [#default-5]

```ts
3
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### scale? [#scale]

\> `optional` **scale?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:62](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L62)

The peak scale multiplier of the first, largest pulse (relative to the component's current
scale) - e.g. `1.2` grows the component 20% bigger at the peak of the first pulse.

#### Default [#default-6]

```ts
1.2
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: PunchEffectProps (/pixi-vn/index/interfaces/PunchEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:143](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L143)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### mode? [#mode]

\> `optional` **mode?**: `"scale"` | `"x"` | `"y"` | `"rotation"`

Defined in: [src/canvas/interfaces/effect-props.ts:148](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L148)

Which property the punch animates.

#### Default [#default-4]

```ts
"scale"
```

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### overshoot? [#overshoot]

\> `optional` **overshoot?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:160](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L160)

How far the recovery overshoots past rest, in the opposite direction, as a fraction of
[strength](#strength) (`0` = no overshoot, settles straight back to rest).

#### Default [#default-5]

```ts
0.3
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:154](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L154)

The strength of the punch's attack - a pixel distance for `x`/`y`, degrees for `rotation`, or a
scale multiplier delta for `scale` (e.g. `0.3` peaks at 1.3x the current scale).

#### Default [#default-7]

```ts
0.3
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: PushInOutProps (/pixi-vn/index/interfaces/PushInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:36](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L36)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/transition-props.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L41)

The direction of the push effect.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### motionBlur? [#motionblur]

\> `optional` **motionBlur?**: `number` | `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:47](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L47)

Adds a motion-blur trail along the movement, ramping up mid-move and back to sharp at the end.
`true` uses a 40px trail; a number sets the trail length (pixels).

#### Default [#default-5]

```ts
false
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: RadialBlurEffectProps (/pixi-vn/index/interfaces/RadialBlurEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:252](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L252)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### bursts? [#bursts]

\> `optional` **bursts?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:262](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L262)

The number of bursts.

#### Default [#default-1]

```ts
1
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### innerRadius? [#innerradius]

\> `optional` **innerRadius?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:272](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L272)

The inner radius (in pixels) excluded from the blur.

#### Default [#default-5]

```ts
0
```

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `object`

Defined in: [src/canvas/interfaces/effect-props.ts:267](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L267)

The origin the blur radiates from, normalized (0-1) to the element's own bounds.

#### x [#x]

\> **x**: `number`

#### y [#y]

\> **y**: `number`

#### Default [#default-7]

```ts
{x: 0.5, y: 0.5}
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### radius? [#radius]

\> `optional` **radius?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:277](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L277)

The outer radius (in pixels) of the blur. A value `< 0` means the blur extends infinitely.

#### Default [#default-8]

```ts
-1
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:257](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L257)

The peak zoom-blur strength of the first, largest burst.

#### Default [#default-10]

```ts
0.5
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-12]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: ResolvedAsset<T> (/pixi-vn/index/interfaces/ResolvedAsset)



Defined in: node_modules/pixi.js/lib/assets/types.d.ts:56

A fully resolved asset, with all the information needed to load it.
This represents an asset that has been processed by the resolver and is ready to be loaded.

## Example [#example]

```ts
// Basic resolved asset
const asset: ResolvedAsset = {
    alias: ['hero'],
    src: 'hero.png',
    format: 'png'
};

// Resolved asset with multiple aliases
const asset: ResolvedAsset = {
    alias: ['character', 'player'],
    src: 'character@2x.webp',
    format: 'webp',
};

// Resolved asset with specific parser
const asset: ResolvedAsset = {
    alias: ['config'],
    src: 'data.txt',
    format: 'txt',
    parser: 'text'
};
```

## Standard [#standard]

## Type Parameters [#type-parameters]

### T [#t]

`T` = `any`

## Properties [#properties]

### alias? [#alias]

\> `optional` **alias?**: `string`\[]

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:58

Array of alternative names for this asset. Used for looking up the same asset by different keys.

***

### data? [#data]

\> `optional` **data?**: `T`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:65

Optional data passed to the asset loader.
Can include texture settings, parser options, or other asset-specific data.

***

### format? [#format]

\> `optional` **format?**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:67

File format of the asset, usually the file extension. Used to determine which loader parser to use.

***

### ~~loadParser?~~ [#loadparser]

\> `optional` **loadParser?**: [`LoadParserName`](/pixi-vn/index/type-aliases/LoadParserName)

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:71

#### Deprecated [#deprecated]

Use `parser` instead.

***

### parser? [#parser]

\> `optional` **parser?**: `AssetParser`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:73

Override to specify which parser should load this asset. Useful when file extensions don't match the content type.

***

### progressSize? [#progresssize]

\> `optional` **progressSize?**: `number`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:79

The amount of progress an asset will contribute to the onProgress event when loading.
This can be any arbitrary value but typically represents the file size.

#### Default [#default]

```ts
1
```

***

### src? [#src]

\> `optional` **src?**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:60

The URL or relative path to the asset. This is the final, resolved path that will be used for loading.


# Interface: ResolvedSrc (/pixi-vn/index/interfaces/ResolvedSrc)



Defined in: node_modules/pixi.js/lib/assets/types.d.ts:117

A fully resolved src specification after pattern resolution and format detection.
Unlike raw asset sources, this type represents the final, concrete source path and format.

## Example [#example]

```ts
// Basic resolved source
const src: ResolvedSrc = {
    src: 'images/sprite.png',
    format: 'png'
};

// With resolution and format preferences
const src: ResolvedSrc = {
    src: 'images/sprite@2x.webp',
    format: 'webp',
    data: { resolution: 2 }
};

// With specific loader
const src: ResolvedSrc = {
    src: 'data/config.txt',
    format: 'txt',
    parser: 'text',
};
```

## Remarks [#remarks]

* Pattern strings like `{png,webp}` are resolved to specific formats
* Resolution and format are determined based on browser support
* Used internally by the Assets system after resolution
* Data property can contain format-specific options

## See [#see]

* [AssetSrc](/pixi-vn/index/type-aliases/AssetSrc) For unresolved source format
* [ResolvedAsset](/pixi-vn/index/interfaces/ResolvedAsset) For complete resolved asset specification

## Advanced [#advanced]

## Properties [#properties]

### data? [#data]

\> `optional` **data?**: `any`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:65

Optional data passed to the asset loader.
Can include texture settings, parser options, or other asset-specific data.

***

### format? [#format]

\> `optional` **format?**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:67

File format of the asset, usually the file extension. Used to determine which loader parser to use.

***

### ~~loadParser?~~ [#loadparser]

\> `optional` **loadParser?**: [`LoadParserName`](/pixi-vn/index/type-aliases/LoadParserName)

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:71

#### Deprecated [#deprecated]

Use `parser` instead.

***

### parser? [#parser]

\> `optional` **parser?**: `AssetParser`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:73

Override to specify which parser should load this asset. Useful when file extensions don't match the content type.

***

### src? [#src]

\> `optional` **src?**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:60

The URL or relative path to the asset. This is the final, resolved path that will be used for loading.


# Interface: RgbColorType (/pixi-vn/index/interfaces/RgbColorType)



Defined in: [src/canvas/types/ColorType.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L1)

## Extended by [#extended-by]

* [`RgbaColorType`](/pixi-vn/index/interfaces/RgbaColorType)

## Properties [#properties]

### b [#b]

\> **b**: `number`

Defined in: [src/canvas/types/ColorType.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L4)

***

### g [#g]

\> **g**: `number`

Defined in: [src/canvas/types/ColorType.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L3)

***

### r [#r]

\> **r**: `number`

Defined in: [src/canvas/types/ColorType.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L2)


# Interface: RgbaColorType (/pixi-vn/index/interfaces/RgbaColorType)



Defined in: [src/canvas/types/ColorType.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L6)

## Extends [#extends]

* [`RgbColorType`](/pixi-vn/index/interfaces/RgbColorType)

## Properties [#properties]

### a [#a]

\> **a**: `number`

Defined in: [src/canvas/types/ColorType.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L7)

***

### b [#b]

\> **b**: `number`

Defined in: [src/canvas/types/ColorType.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L4)

#### Inherited from [#inherited-from]

[`RgbColorType`](/pixi-vn/index/interfaces/RgbColorType).[`b`](/pixi-vn/index/interfaces/RgbColorType#b)

***

### g [#g]

\> **g**: `number`

Defined in: [src/canvas/types/ColorType.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L3)

#### Inherited from [#inherited-from-1]

[`RgbColorType`](/pixi-vn/index/interfaces/RgbColorType).[`g`](/pixi-vn/index/interfaces/RgbColorType#g)

***

### r [#r]

\> **r**: `number`

Defined in: [src/canvas/types/ColorType.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L2)

#### Inherited from [#inherited-from-2]

[`RgbColorType`](/pixi-vn/index/interfaces/RgbColorType).[`r`](/pixi-vn/index/interfaces/RgbColorType#r)


# Interface: RippleInOutProps (/pixi-vn/index/interfaces/RippleInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:233](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L233)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), RippleInOutProps,
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### amplitude? [#amplitude]

\> `optional` **amplitude?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:243](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L243)

The amplitude of the ripple.

#### Default [#default-1]

```ts
30
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `Partial`\<`PointData`>

Defined in: [src/canvas/interfaces/transition-props.ts:238](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L238)

The point the ripple starts from, normalized to the component's own bounds.

#### Default [#default-5]

```ts
{ x: 0.5, y: 0.5 }
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### speed? [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:254](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L254)

The speed (pixels-per-second, in the ripple's own time) the ring travels outward. The ring always
travels until it has left the component; `speed` only shapes the ring.

#### Default [#default-6]

```ts
500
```

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### wavelength? [#wavelength]

\> `optional` **wavelength?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:248](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L248)

The wavelength of the ripple.

#### Default [#default-10]

```ts
160
```

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: ShakeEffectProps (/pixi-vn/index/interfaces/ShakeEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L4)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### maxShockSize? [#maxshocksize]

\> `optional` **maxShockSize?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L21)

The maximum size of the shock.
For horizontal type, it is the maximum size of the x axis.
For vertical type, it is the maximum size of the y axis.

#### Default [#default-4]

```ts
10
```

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### shakeType? [#shaketype]

\> `optional` **shakeType?**: `"horizontal"` | `"vertical"`

Defined in: [src/canvas/interfaces/effect-props.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L14)

The type of the shake effect

#### Default [#default-5]

```ts
"horizontal"
```

***

### shocksNumber? [#shocksnumber]

\> `optional` **shocksNumber?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L9)

The number of shocks. **Must be at least 3**.

#### Default [#default-6]

```ts
10
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: ShockwaveEffectProps (/pixi-vn/index/interfaces/ShockwaveEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:211](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L211)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### amplitude? [#amplitude]

\> `optional` **amplitude?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:221](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L221)

The amplitude of the ripple.

#### Default [#default-1]

```ts
30
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### brightness? [#brightness]

\> `optional` **brightness?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:231](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L231)

The brightness of the ripple.

#### Default [#default-2]

```ts
1
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-3]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-4]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### origin? [#origin]

\> `optional` **origin?**: `object`

Defined in: [src/canvas/interfaces/effect-props.ts:216](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L216)

The origin of the ripple, normalized (0-1) to the element's own bounds.

#### x [#x]

\> **x**: `number`

#### y [#y]

\> **y**: `number`

#### Default [#default-6]

```ts
{x: 0.5, y: 0.5}
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### radius? [#radius]

\> `optional` **radius?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:237](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L237)

The maximum radius (in pixels) the ripple travels before fading out. A value `<= 0` means the
ripple travels an infinite distance.

#### Default [#default-7]

```ts
-1
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### speed? [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:242](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L242)

The speed (in pixels-per-second) the ripple travels outward.

#### Default [#default-8]

```ts
500
```

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:249](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L249)

How far the ripple's own internal "time" advances by the end of the animation (the ring's
radius is `time * speed` pixels). By default it's just enough for the ring to fully leave the
component - origin to farthest corner plus half a [wavelength](#wavelength) - or [radius](#radius) when set,
divided by [speed](#speed).

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### wavelength? [#wavelength]

\> `optional` **wavelength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:226](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L226)

The wavelength of the ripple.

#### Default [#default-12]

```ts
160
```

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: ShowWithDissolveTransitionProps (/pixi-vn/index/interfaces/ShowWithDissolveTransitionProps)



Defined in: [src/canvas/interfaces/transition-props.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L14)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: ShowWithFadeTransitionProps (/pixi-vn/index/interfaces/ShowWithFadeTransitionProps)



Defined in: [src/canvas/interfaces/transition-props.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L15)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: SoundChannelsInterface (/pixi-vn/index/interfaces/SoundChannelsInterface)



Defined in: [src/sound/interfaces/SoundChannelsInterface.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundChannelsInterface.ts#L4)

## Properties [#properties]

### values [#values]

\> `readonly` **values**: [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)\[]

Defined in: [src/sound/interfaces/SoundChannelsInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundChannelsInterface.ts#L15)

All registered audio channels.

## Methods [#methods]

### add() [#add]

\> **add**(`alias`, `options?`): [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface) | `undefined`

Defined in: [src/sound/interfaces/SoundChannelsInterface.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundChannelsInterface.ts#L9)

Add a new audio channel.
Returns the created channel, or `undefined` if the alias already exists.

#### Parameters [#parameters]

##### alias [#alias]

`string` | `string`\[]

##### options? [#options]

[`ChannelOptions`](/pixi-vn/index/interfaces/ChannelOptions)

#### Returns [#returns]

[`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface) | `undefined`

***

### find() [#find]

\> **find**(`alias`): [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)

Defined in: [src/sound/interfaces/SoundChannelsInterface.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundChannelsInterface.ts#L13)

Find the channel for the given alias, creating it if it does not yet exist.

#### Parameters [#parameters-1]

##### alias [#alias-1]

`string`

#### Returns [#returns-1]

[`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)


# Interface: SoundGameState (/pixi-vn/index/interfaces/SoundGameState)



Defined in: [src/sound/interfaces/SoundGameState.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L24)

Interface exported sounds

## Properties [#properties]

### mediaInstances [#mediainstances]

\> **mediaInstances**: `object`

Defined in: [src/sound/interfaces/SoundGameState.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L29)

#### Index Signature [#index-signature]

\[`key`: `string`]: `object`

***

### ~~soundsPlaying?~~ [#soundsplaying]

\> `optional` **soundsPlaying?**: `object`

Defined in: [src/sound/interfaces/SoundGameState.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L28)

#### Index Signature [#index-signature-1]

\[`key`: `string`]: [`ExportedSoundPlay`](/pixi-vn/index/interfaces/ExportedSoundPlay)

#### Deprecated [#deprecated]


# Interface: SoundManagerInterface (/pixi-vn/index/interfaces/SoundManagerInterface)



Defined in: [src/sound/interfaces/SoundManagerInterface.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L9)

## Properties [#properties]

### channels [#channels]

\> `readonly` **channels**: [`SoundChannelsInterface`](/pixi-vn/index/interfaces/SoundChannelsInterface)

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:148](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L148)

Namespace for operations on audio channels.

***

### defaultChannelAlias [#defaultchannelalias]

\> **defaultChannelAlias**: `string`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L21)

The default channel alias used when playing a sound without specifying a
channel. Defaults to `"general"`.

***

### muted [#muted]

\> `readonly` **muted**: `boolean`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L76)

Whether all sounds are currently muted. Note that individual channels or media instances may still be muted or unmuted; this is just the global master mute state.

***

### ~~speedAll~~ [#speedall]

\> **speedAll**: `number`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L15)

#### Deprecated [#deprecated]

Global playback speed. This is not a well-supported feature and may be removed in a future release. Use individual sound speed options instead.

***

### unsaved [#unsaved]

\> `readonly` **unsaved**: [`SoundUnsavedInterface`](/pixi-vn/index/interfaces/SoundUnsavedInterface)

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:117](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L117)

Namespace for operations on unsaved / transient playback state (not tracked in save/export state).

***

### volumeAll [#volumeall]

\> **volumeAll**: `number`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L11)

Master volume in the range \[0, 1].

## Methods [#methods]

### ~~add()~~ [#add]

\> **add**(`alias`, `options`): `void`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L26)

#### Parameters [#parameters]

##### alias [#alias]

`string`

##### options [#options]

`string`

#### Returns [#returns]

`void`

#### Deprecated [#deprecated-1]

Register sound assets directly via `PIXI.Assets` instead.

***

### ~~addChannel()~~ [#addchannel]

\> **addChannel**(`alias`, `options?`): [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface) | `undefined`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:134](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L134)

Add a new audio channel.
Returns the created channel, or `undefined` if the alias already exists.

#### Parameters [#parameters-1]

##### alias [#alias-1]

`string` | `string`\[]

##### options? [#options-1]

[`ChannelOptions`](/pixi-vn/index/interfaces/ChannelOptions)

#### Returns [#returns-1]

[`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface) | `undefined`

#### Deprecated [#deprecated-2]

Use [channels](#channels).add instead.

***

### backgroundLoad() [#backgroundload]

\> **backgroundLoad**(...`alias`): `Promise`\<`void`>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:122](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L122)

Trigger background loading of one or more sound assets.

#### Parameters [#parameters-2]

##### alias [#alias-2]

...`string`\[]

#### Returns [#returns-2]

`Promise`\<`void`>

***

### backgroundLoadBundle() [#backgroundloadbundle]

\> **backgroundLoadBundle**(`alias`): `Promise`\<`void`>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:124](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L124)

Trigger background loading of a sound bundle.

#### Parameters [#parameters-3]

##### alias [#alias-3]

`string`

#### Returns [#returns-3]

`Promise`\<`void`>

***

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:127](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L127)

Stop all sounds and clear internal state.

#### Returns [#returns-4]

`void`

***

### duration() [#duration]

\> **duration**(`alias`): `number`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:69](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L69)

Duration in seconds of the loaded sound with the given alias.

#### Parameters [#parameters-4]

##### alias [#alias-4]

`string`

#### Returns [#returns-5]

`number`

***

### export() [#export]

\> **export**(): [`SoundGameState`](/pixi-vn/index/interfaces/SoundGameState)

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:153](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L153)

Export the current sound state, including currently playing sounds and their options, for saving or debugging purposes. This is not guaranteed to be stable across versions and may contain implementation details; it is not intended for use in general application code.

#### Returns [#returns-6]

[`SoundGameState`](/pixi-vn/index/interfaces/SoundGameState)

***

### find() [#find]

\> **find**(`alias`): [`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L51)

Find a tracked media instance by alias.

#### Parameters [#parameters-5]

##### alias [#alias-5]

`string`

#### Returns [#returns-7]

[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

***

### ~~findChannel()~~ [#findchannel]

\> **findChannel**(`alias`): [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:143](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L143)

Find the channel for the given alias, creating it if it does not yet exist.

#### Parameters [#parameters-6]

##### alias [#alias-6]

`string`

#### Returns [#returns-8]

[`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)

#### Deprecated [#deprecated-3]

Use [channels](#channels).find instead.

***

### load() [#load]

\> **load**(...`alias`): `Promise`\<`void`>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:120](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L120)

Load one or more sound assets.

#### Parameters [#parameters-7]

##### alias [#alias-7]

...`string`\[]

#### Returns [#returns-9]

`Promise`\<`void`>

***

### muteAll() [#muteall]

\> **muteAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:78](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L78)

Mute all sounds.

#### Returns [#returns-10]

`this`

***

### pause() [#pause]

\> **pause**(`alias`): [`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:61](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L61)

Pause a tracked media instance.

#### Parameters [#parameters-8]

##### alias [#alias-8]

`string`

#### Returns [#returns-11]

[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

***

### pauseAll() [#pauseall]

\> **pauseAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:84](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L84)

Pause all sounds.

#### Returns [#returns-12]

`this`

***

### ~~pauseUnsavedAll()~~ [#pauseunsavedall]

\> **pauseUnsavedAll**(`channel?`): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:100](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L100)

Temporarily pause all currently-playing sounds (or just those in the given
channel) without persisting the paused state. Useful for overlays / pause
menus.

Only sounds that are **actively playing** at the time of the call are paused;
sounds that were already paused beforehand are left untouched so that they
remain paused when [resumeUnsavedAll](#resumeunsavedall) is called later.

When called without a channel argument all transient players started with
[playTransient](#playtransient) are also stopped.

#### Parameters [#parameters-9]

##### channel? [#channel]

`string`

#### Returns [#returns-13]

`this`

#### Deprecated [#deprecated-4]

Use [unsaved](#unsaved).pauseAll instead.

***

### play() [#play]

#### Call Signature [#call-signature]

\> **play**(`alias`, `options?`): `Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L34)

Plays a sound.

##### Parameters [#parameters-10]

###### alias [#alias-9]

`string`

The media and sound (asset) alias reference.

###### options? [#options-2]

[`SoundPlayOptionsWithChannel`](/pixi-vn/index/interfaces/SoundPlayOptionsWithChannel)

The options.

##### Returns [#returns-14]

`Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

The media instance (resolves immediately if already loaded).

#### Call Signature [#call-signature-1]

\> **play**(`mediaAlias`, `soundAlias`, `options?`): `Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L35)

##### Parameters [#parameters-11]

###### mediaAlias [#mediaalias]

`string`

###### soundAlias [#soundalias]

`string`

###### options? [#options-3]

[`SoundPlayOptionsWithChannel`](/pixi-vn/index/interfaces/SoundPlayOptionsWithChannel)

##### Returns [#returns-15]

`Promise`\<[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface)>

***

### ~~playTransient()~~ [#playtransient]

\> **playTransient**(`alias`, `options?`): `Promise`\<`Player`>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:46](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L46)

Plays a non-persistent ("transient") sound (e.g. UI / menu sounds).
Transient playback is not tracked in save/export state.

#### Parameters [#parameters-12]

##### alias [#alias-10]

`string`

##### options? [#options-4]

`Partial`\<`PlayerOptions`>

#### Returns [#returns-16]

`Promise`\<`Player`>

#### Deprecated [#deprecated-5]

Use [unsaved](#unsaved).playTransient instead.

***

### restore() [#restore]

\> **restore**(`data`): `Promise`\<`void`>

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:157](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L157)

Restore a sound state exported by [export](#export). This will stop any currently playing sounds and replace them with the sounds specified in the exported state. This is not guaranteed to be stable across versions and may contain implementation details; it is not intended for use in general application code.

#### Parameters [#parameters-13]

##### data [#data]

`object`

#### Returns [#returns-17]

`Promise`\<`void`>

***

### resume() [#resume]

\> **resume**(`alias`): [`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:66](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L66)

Resume a paused media instance.

#### Parameters [#parameters-14]

##### alias [#alias-11]

`string`

#### Returns [#returns-18]

[`MediaInterface`](/pixi-vn/index/interfaces/MediaInterface) | `undefined`

***

### resumeAll() [#resumeall]

\> **resumeAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L86)

Resume all sounds.

#### Returns [#returns-19]

`this`

***

### ~~resumeUnsavedAll()~~ [#resumeunsavedall]

\> **resumeUnsavedAll**(`channel?`): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:107](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L107)

Resume all sounds (or just those in the given channel) that were paused by
the most recent call to [pauseUnsavedAll](#pauseunsavedall). Sounds that were already
paused before `pauseUnsavedAll` was called are **not** resumed.

#### Parameters [#parameters-15]

##### channel? [#channel-1]

`string`

#### Returns [#returns-20]

`this`

#### Deprecated [#deprecated-6]

Use [unsaved](#unsaved).resumeAll instead.

***

### stop() [#stop]

\> **stop**(`alias`): `void`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L56)

Stop a tracked media instance and remove it from the manager.

#### Parameters [#parameters-16]

##### alias [#alias-12]

`string`

#### Returns [#returns-21]

`void`

***

### stopAll() [#stopall]

\> **stopAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:82](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L82)

Stop all sounds.

#### Returns [#returns-22]

`this`

***

### ~~stopTransientAll()~~ [#stoptransientall]

\> **stopTransientAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:112](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L112)

Stop all transient media instances started with [playTransient](#playtransient).

#### Returns [#returns-23]

`this`

#### Deprecated [#deprecated-7]

Use [unsaved](#unsaved).stopTransientAll instead.

***

### toggleMuteAll() [#togglemuteall]

\> **toggleMuteAll**(): `boolean`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:72](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L72)

Toggle mute on all sounds. Returns the new muted state.

#### Returns [#returns-24]

`boolean`

***

### unmuteAll() [#unmuteall]

\> **unmuteAll**(): `this`

Defined in: [src/sound/interfaces/SoundManagerInterface.ts:80](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundManagerInterface.ts#L80)

Unmute all sounds.

#### Returns [#returns-25]

`this`


# Interface: SoundOptions (/pixi-vn/index/interfaces/SoundOptions)



Defined in: [src/sound/interfaces/SoundOptions.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L3)

## Extends [#extends]

* `Pick`\<`Partial`\<`PlayerOptions`>, `"loop"` | `"autostart"` | `"fadeIn"` | `"fadeOut"` | `"mute"` | `"loopEnd"` | `"loopStart"` | `"reverse"` | `"playbackRate"`>

## Extended by [#extended-by]

* [`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

#### Inherited from [#inherited-from]

`Pick.autostart`

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

#### Inherited from [#inherited-from-1]

`Pick.fadeIn`

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

#### Inherited from [#inherited-from-2]

`Pick.fadeOut`

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L34)

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

#### Inherited from [#inherited-from-3]

`Pick.loop`

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

#### Inherited from [#inherited-from-4]

`Pick.loopEnd`

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

#### Inherited from [#inherited-from-5]

`Pick.loopStart`

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

#### Inherited from [#inherited-from-6]

`Pick.mute`

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L42)

#### Deprecated [#deprecated]

Use [mute](#mute) instead.

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

#### Inherited from [#inherited-from-7]

`Pick.playbackRate`

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

#### Inherited from [#inherited-from-8]

`Pick.reverse`

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L38)

#### Deprecated [#deprecated-1]

Use [playbackRate](#playbackrate) instead.

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L21)

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.


# Interface: SoundPlay (/pixi-vn/index/interfaces/SoundPlay)



Defined in: [src/sound/interfaces/SoundGameState.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L11)

## Extended by [#extended-by]

* [`ExportedSoundPlay`](/pixi-vn/index/interfaces/ExportedSoundPlay)

## Properties [#properties]

### options? [#options]

\> `optional` **options?**: `string` | [`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

Defined in: [src/sound/interfaces/SoundGameState.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L14)

***

### paused [#paused]

\> **paused**: `boolean`

Defined in: [src/sound/interfaces/SoundGameState.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L13)

***

### stepIndex [#stepindex]

\> **stepIndex**: `number`

Defined in: [src/sound/interfaces/SoundGameState.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundGameState.ts#L12)


# Interface: SoundPlayOptions (/pixi-vn/index/interfaces/SoundPlayOptions)



Defined in: [src/sound/interfaces/SoundOptions.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L45)

## Extends [#extends]

* [`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions)

## Extended by [#extended-by]

* [`SoundPlayOptionsWithChannel`](/pixi-vn/index/interfaces/SoundPlayOptionsWithChannel)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

#### Inherited from [#inherited-from]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`autostart`](/pixi-vn/index/interfaces/SoundOptions#autostart)

***

### delay? [#delay]

\> `optional` **delay?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L51)

The delay in seconds before playback starts. If specified, playback is
scheduled to begin after the delay has elapsed rather than starting
immediately in a paused state.

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L55)

The offset in seconds from the start of the sound at which to begin playback.

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

#### Inherited from [#inherited-from-1]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`fadeIn`](/pixi-vn/index/interfaces/SoundOptions#fadein)

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

#### Inherited from [#inherited-from-2]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`fadeOut`](/pixi-vn/index/interfaces/SoundOptions#fadeout)

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L34)

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

#### Inherited from [#inherited-from-3]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`filters`](/pixi-vn/index/interfaces/SoundOptions#filters)

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

#### Inherited from [#inherited-from-4]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`loop`](/pixi-vn/index/interfaces/SoundOptions#loop)

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

#### Inherited from [#inherited-from-5]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`loopEnd`](/pixi-vn/index/interfaces/SoundOptions#loopend)

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

#### Inherited from [#inherited-from-6]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`loopStart`](/pixi-vn/index/interfaces/SoundOptions#loopstart)

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

#### Inherited from [#inherited-from-7]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`mute`](/pixi-vn/index/interfaces/SoundOptions#mute)

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L42)

#### Deprecated [#deprecated]

Use [mute](/pixi-vn/index/interfaces/SoundOptions#mute) instead.

#### Inherited from [#inherited-from-8]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`muted`](/pixi-vn/index/interfaces/SoundOptions#muted)

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

#### Inherited from [#inherited-from-9]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`playbackRate`](/pixi-vn/index/interfaces/SoundOptions#playbackrate)

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

#### Inherited from [#inherited-from-10]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`reverse`](/pixi-vn/index/interfaces/SoundOptions#reverse)

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L38)

#### Deprecated [#deprecated-1]

Use [playbackRate](/pixi-vn/index/interfaces/SoundOptions#playbackrate) instead.

#### Inherited from [#inherited-from-11]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`speed`](/pixi-vn/index/interfaces/SoundOptions#speed)

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L21)

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-12]

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`volume`](/pixi-vn/index/interfaces/SoundOptions#volume)


# Interface: SoundPlayOptionsWithChannel (/pixi-vn/index/interfaces/SoundPlayOptionsWithChannel)



Defined in: [src/sound/interfaces/SoundOptions.ts:58](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L58)

## Extends [#extends]

* [`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

#### Inherited from [#inherited-from]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`autostart`](/pixi-vn/index/interfaces/SoundPlayOptions#autostart)

***

### channel? [#channel]

\> `optional` **channel?**: `string`

Defined in: [src/sound/interfaces/SoundOptions.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L64)

The alias of the audio channel to play the sound on. If the channel does
not exist it will be created automatically.
Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").

***

### delay? [#delay]

\> `optional` **delay?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L51)

The delay in seconds before playback starts. If specified, playback is
scheduled to begin after the delay has elapsed rather than starting
immediately in a paused state.

#### Inherited from [#inherited-from-1]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`delay`](/pixi-vn/index/interfaces/SoundPlayOptions#delay)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L55)

The offset in seconds from the start of the sound at which to begin playback.

#### Inherited from [#inherited-from-2]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`elapsed`](/pixi-vn/index/interfaces/SoundPlayOptions#elapsed)

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

#### Inherited from [#inherited-from-3]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`fadeIn`](/pixi-vn/index/interfaces/SoundPlayOptions#fadein)

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

#### Inherited from [#inherited-from-4]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`fadeOut`](/pixi-vn/index/interfaces/SoundPlayOptions#fadeout)

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L34)

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

#### Inherited from [#inherited-from-5]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`filters`](/pixi-vn/index/interfaces/SoundPlayOptions#filters)

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

#### Inherited from [#inherited-from-6]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`loop`](/pixi-vn/index/interfaces/SoundPlayOptions#loop)

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

#### Inherited from [#inherited-from-7]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`loopEnd`](/pixi-vn/index/interfaces/SoundPlayOptions#loopend)

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

#### Inherited from [#inherited-from-8]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`loopStart`](/pixi-vn/index/interfaces/SoundPlayOptions#loopstart)

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

#### Inherited from [#inherited-from-9]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`mute`](/pixi-vn/index/interfaces/SoundPlayOptions#mute)

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L42)

#### Deprecated [#deprecated]

Use [mute](/pixi-vn/index/interfaces/SoundOptions#mute) instead.

#### Inherited from [#inherited-from-10]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`muted`](/pixi-vn/index/interfaces/SoundPlayOptions#muted)

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

#### Inherited from [#inherited-from-11]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`playbackRate`](/pixi-vn/index/interfaces/SoundPlayOptions#playbackrate)

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

#### Inherited from [#inherited-from-12]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`reverse`](/pixi-vn/index/interfaces/SoundPlayOptions#reverse)

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L38)

#### Deprecated [#deprecated-1]

Use [playbackRate](/pixi-vn/index/interfaces/SoundOptions#playbackrate) instead.

#### Inherited from [#inherited-from-13]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`speed`](/pixi-vn/index/interfaces/SoundPlayOptions#speed)

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L21)

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-14]

[`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions).[`volume`](/pixi-vn/index/interfaces/SoundPlayOptions#volume)


# Interface: SoundUnsavedInterface (/pixi-vn/index/interfaces/SoundUnsavedInterface)



Defined in: [src/sound/interfaces/SoundUnsavedInterface.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundUnsavedInterface.ts#L3)

## Methods [#methods]

### pauseAll() [#pauseall]

\> **pauseAll**(`channel?`): `this`

Defined in: [src/sound/interfaces/SoundUnsavedInterface.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundUnsavedInterface.ts#L21)

Temporarily pause all currently-playing sounds (or just those in the given
channel) without persisting the paused state. Useful for overlays / pause
menus.

Only sounds that are **actively playing** at the time of the call are paused;
sounds that were already paused beforehand are left untouched so that they
remain paused when [resumeAll](#resumeall) is called later.

When called without a channel argument all transient players started with
[playTransient](#playtransient) are also stopped.

#### Parameters [#parameters]

##### channel? [#channel]

`string`

#### Returns [#returns]

`this`

***

### playTransient() [#playtransient]

\> **playTransient**(`alias`, `options?`): `Promise`\<`Player`>

Defined in: [src/sound/interfaces/SoundUnsavedInterface.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundUnsavedInterface.ts#L8)

Plays a non-persistent ("transient") sound (e.g. UI / menu sounds).
Transient playback is not tracked in save/export state.

#### Parameters [#parameters-1]

##### alias [#alias]

`string`

##### options? [#options]

`Partial`\<`PlayerOptions`>

#### Returns [#returns-1]

`Promise`\<`Player`>

***

### resumeAll() [#resumeall]

\> **resumeAll**(`channel?`): `this`

Defined in: [src/sound/interfaces/SoundUnsavedInterface.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundUnsavedInterface.ts#L27)

Resume all sounds (or just those in the given channel) that were paused by
the most recent call to [pauseAll](#pauseall). Sounds that were already
paused before `pauseAll` was called are **not** resumed.

#### Parameters [#parameters-2]

##### channel? [#channel-1]

`string`

#### Returns [#returns-2]

`this`

***

### stopTransientAll() [#stoptransientall]

\> **stopTransientAll**(): `this`

Defined in: [src/sound/interfaces/SoundUnsavedInterface.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundUnsavedInterface.ts#L31)

Stop all transient media instances started with [playTransient](#playtransient).

#### Returns [#returns-3]

`this`


# Interface: SplitInOutProps (/pixi-vn/index/interfaces/SplitInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:88](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L88)

Shared options for the mask-based reveal/conceal transitions ([WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps),
[IrisInOutProps](/pixi-vn/index/interfaces/IrisInOutProps), SplitInOutProps).

## Extends [#extends]

* [`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`MaskTransitionProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/MaskTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounce`](/pixi-vn/index/interfaces/MaskTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/MaskTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`damping`](/pixi-vn/index/interfaces/MaskTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delay`](/pixi-vn/index/interfaces/MaskTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`driver`](/pixi-vn/index/interfaces/MaskTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`duration`](/pixi-vn/index/interfaces/MaskTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`ease`](/pixi-vn/index/interfaces/MaskTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/MaskTransitionProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`from`](/pixi-vn/index/interfaces/MaskTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`inherit`](/pixi-vn/index/interfaces/MaskTransitionProps#inherit)

***

### invert? [#invert]

\> `optional` **invert?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L59)

If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.

#### Default [#default-3]

```ts
false
```

#### Inherited from [#inherited-from-15]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`invert`](/pixi-vn/index/interfaces/MaskTransitionProps#invert)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`isSync`](/pixi-vn/index/interfaces/MaskTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`mass`](/pixi-vn/index/interfaces/MaskTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`max`](/pixi-vn/index/interfaces/MaskTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`min`](/pixi-vn/index/interfaces/MaskTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/MaskTransitionProps#modifytarget)

***

### orientation? [#orientation]

\> `optional` **orientation?**: `"horizontal"` | `"vertical"`

Defined in: [src/canvas/interfaces/transition-props.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L93)

The axis the two mask panels move apart on/towards.

#### Default [#default-5]

```ts
"vertical"
```

***

### origin? [#origin]

\> `optional` **origin?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L99)

The origin of the split line, normalized to the component's own bounds (`0` to `1` on the axis
perpendicular to [orientation](#orientation)).

#### Default [#default-6]

```ts
0.5
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`path`](/pixi-vn/index/interfaces/MaskTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`power`](/pixi-vn/index/interfaces/MaskTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/MaskTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeat`](/pixi-vn/index/interfaces/MaskTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/MaskTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/MaskTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/MaskTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/MaskTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/MaskTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`startTime`](/pixi-vn/index/interfaces/MaskTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`MaskTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`MaskTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/MaskTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`times`](/pixi-vn/index/interfaces/MaskTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`type`](/pixi-vn/index/interfaces/MaskTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`velocity`](/pixi-vn/index/interfaces/MaskTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/MaskTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`when`](/pixi-vn/index/interfaces/MaskTransitionProps#when)


# Interface: SpriteBaseMemory (/pixi-vn/index/interfaces/SpriteBaseMemory)



Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L7)

Interface for the canvas base memory

## Extends [#extends]

* `SpriteOptions`.[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory).[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Extended by [#extended-by]

* [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)
* [`SpriteMemory`](/pixi-vn/index/interfaces/SpriteMemory)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`SpriteOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`SpriteOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`SpriteOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`SpriteOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`SpriteOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`SpriteOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`SpriteOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

`SpriteOptions.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

`SpriteOptions.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`SpriteOptions.angle`

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

`SpriteOptions.autoGarbageCollect`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

`SpriteOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

`SpriteOptions.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

`SpriteOptions.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

`SpriteOptions.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

`SpriteOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

`SpriteOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

`SpriteOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

`SpriteOptions.cursor`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

`SpriteOptions.eventMode`

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

`SpriteOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

`SpriteOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

`SpriteOptions.hitArea`

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`index`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

`SpriteOptions.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

`SpriteOptions.interactiveChildren`

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

`SpriteOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`label`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`SpriteOptions.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-29]

`SpriteOptions.onclick`

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-30]

[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory).[`onEvents`](/pixi-vn/index/interfaces/ListenerExtensionMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

`SpriteOptions.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

`SpriteOptions.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-33]

`SpriteOptions.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-34]

`SpriteOptions.onmousedown`

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-35]

`SpriteOptions.onmouseenter`

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-36]

`SpriteOptions.onmouseleave`

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-37]

`SpriteOptions.onmousemove`

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-38]

`SpriteOptions.onmouseout`

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-39]

`SpriteOptions.onmouseover`

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-40]

`SpriteOptions.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-41]

`SpriteOptions.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-42]

`SpriteOptions.onpointercancel`

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-43]

`SpriteOptions.onpointerdown`

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-44]

`SpriteOptions.onpointerenter`

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-45]

`SpriteOptions.onpointerleave`

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-46]

`SpriteOptions.onpointermove`

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-47]

`SpriteOptions.onpointerout`

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-48]

`SpriteOptions.onpointerover`

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-49]

`SpriteOptions.onpointertap`

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-50]

`SpriteOptions.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

`SpriteOptions.onpointerupoutside`

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-52]

`SpriteOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-53]

`SpriteOptions.onrightclick`

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-54]

`SpriteOptions.onrightdown`

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-55]

`SpriteOptions.onrightup`

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-56]

`SpriteOptions.onrightupoutside`

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-57]

`SpriteOptions.ontap`

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-58]

`SpriteOptions.ontouchcancel`

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-59]

`SpriteOptions.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-60]

`SpriteOptions.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-61]

`SpriteOptions.ontouchmove`

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-62]

`SpriteOptions.ontouchstart`

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-63]

`SpriteOptions.onwheel`

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-64]

`SpriteOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-65]

`SpriteOptions.parent`

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-66]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`parentLabel`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-70]

`SpriteOptions.pivot`

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-71]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-72]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnId`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-73]

`SpriteOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-74]

`SpriteOptions.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-75]

`SpriteOptions.rotation`

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-76]

`SpriteOptions.roundPixels`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-77]

`SpriteOptions.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-78]

`SpriteOptions.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-79]

`SpriteOptions.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-80]

`SpriteOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-81]

`SpriteOptions.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-82]

`SpriteOptions.tabIndex`

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-83]

`SpriteOptions.texture`

***

### textureData? [#texturedata]

> `optional` **textureData?**: [`AssetMemory`](/pixi-vn/index/interfaces/AssetMemory)

Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L12)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-84]

`SpriteOptions.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-85]

`SpriteOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-86]

`SpriteOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-87]

`SpriteOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-88]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-89]

`SpriteOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-90]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-91]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`zIndex`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#zindex)


# Interface: SpriteMemory (/pixi-vn/index/interfaces/SpriteMemory)



Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L18)

Interface for the canvas sprite memory

## Extends [#extends]

* [`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessible`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleHint`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleText`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleTitle`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`accessibleType`](/pixi-vn/index/interfaces/SpriteBaseMemory#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`align`](/pixi-vn/index/interfaces/SpriteBaseMemory#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`alpha`](/pixi-vn/index/interfaces/SpriteBaseMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`anchor`](/pixi-vn/index/interfaces/ImageSpriteMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`angle`](/pixi-vn/index/interfaces/SpriteBaseMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/SpriteBaseMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`blendMode`](/pixi-vn/index/interfaces/SpriteBaseMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`boundsArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/SpriteBaseMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`children`](/pixi-vn/index/interfaces/SpriteBaseMemory#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullable`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullableChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cullArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`cursor`](/pixi-vn/index/interfaces/SpriteBaseMemory#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`eventMode`](/pixi-vn/index/interfaces/SpriteBaseMemory#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`filters`](/pixi-vn/index/interfaces/SpriteBaseMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`height`](/pixi-vn/index/interfaces/SpriteBaseMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`hitArea`](/pixi-vn/index/interfaces/SpriteBaseMemory#hitarea)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`index`](/pixi-vn/index/interfaces/SpriteBaseMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`interactive`](/pixi-vn/index/interfaces/SpriteBaseMemory#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`interactiveChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/SpriteBaseMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`label`](/pixi-vn/index/interfaces/SpriteBaseMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`mask`](/pixi-vn/index/interfaces/SpriteBaseMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onclick`](/pixi-vn/index/interfaces/SpriteBaseMemory#onclick)

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-30]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onEvents`](/pixi-vn/index/interfaces/SpriteBaseMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobalmousemove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobalpointermove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-33]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onglobaltouchmove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmousedown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseenter`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseleave`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmousemove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseout`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseover`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onmouseupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointercancel`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerdown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerenter`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerleave`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointermove`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerout`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerover`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointertap`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onpointerupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-52]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onRender`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightclick`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightdown`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightup`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onrightupoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontap`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchcancel`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchend`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchendoutside`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchmove`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`ontouchstart`](/pixi-vn/index/interfaces/SpriteBaseMemory#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`onwheel`](/pixi-vn/index/interfaces/SpriteBaseMemory#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-64]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-65]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-66]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`parentLabel`](/pixi-vn/index/interfaces/SpriteBaseMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentagePosition`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentageX`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`percentageY`](/pixi-vn/index/interfaces/SpriteBaseMemory#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-70]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pivot`](/pixi-vn/index/interfaces/SpriteBaseMemory#pivot)

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-71]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/SpriteBaseMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-72]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`pixivnId`](/pixi-vn/index/interfaces/SpriteBaseMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-73]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`position`](/pixi-vn/index/interfaces/SpriteBaseMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-74]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`renderable`](/pixi-vn/index/interfaces/SpriteBaseMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-75]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`rotation`](/pixi-vn/index/interfaces/SpriteBaseMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-76]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`roundPixels`](/pixi-vn/index/interfaces/SpriteBaseMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-77]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`scale`](/pixi-vn/index/interfaces/SpriteBaseMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-78]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`setMask`](/pixi-vn/index/interfaces/SpriteBaseMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-79]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`skew`](/pixi-vn/index/interfaces/SpriteBaseMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-80]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`sortableChildren`](/pixi-vn/index/interfaces/SpriteBaseMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-81]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`sortDirty`](/pixi-vn/index/interfaces/SpriteBaseMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-82]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`tabIndex`](/pixi-vn/index/interfaces/SpriteBaseMemory#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-83]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`texture`](/pixi-vn/index/interfaces/SpriteBaseMemory#texture)

***

### textureData? [#texturedata]

> `optional` **textureData?**: [`AssetMemory`](/pixi-vn/index/interfaces/AssetMemory)

Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L12)

#### Inherited from [#inherited-from-84]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`textureData`](/pixi-vn/index/interfaces/SpriteBaseMemory#texturedata)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-85]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`tint`](/pixi-vn/index/interfaces/SpriteBaseMemory#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-86]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`visible`](/pixi-vn/index/interfaces/SpriteBaseMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-87]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`width`](/pixi-vn/index/interfaces/SpriteBaseMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-88]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`x`](/pixi-vn/index/interfaces/SpriteBaseMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-89]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`xAlign`](/pixi-vn/index/interfaces/SpriteBaseMemory#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-90]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`y`](/pixi-vn/index/interfaces/SpriteBaseMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-91]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`yAlign`](/pixi-vn/index/interfaces/SpriteBaseMemory#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-92]

[`SpriteBaseMemory`](/pixi-vn/index/interfaces/SpriteBaseMemory).[`zIndex`](/pixi-vn/index/interfaces/SpriteBaseMemory#zindex)


# Interface: SpriteOptions (/pixi-vn/index/interfaces/SpriteOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L14)

## Extends [#extends]

* `Omit`\<`PixiSpriteOptions`, `"on"`>.[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Extended by [#extended-by]

* [`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`Omit.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`Omit.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`Omit.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`Omit.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`Omit.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`Omit.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`Omit.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`anchor`](/pixi-vn/index/interfaces/ImageSpriteMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/ImageSpriteMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

`Omit.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

`Omit.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

`Omit.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-25]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-26]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-63]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-71]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`roundPixels`](/pixi-vn/index/interfaces/ImageSpriteMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-74]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-75]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-76]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-77]

`Omit.tabIndex`

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-78]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`texture`](/pixi-vn/index/interfaces/ImageSpriteMemory#texture)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-79]

`Omit.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-80]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-81]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-82]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-83]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-84]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-86]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: StepLabelProps (/pixi-vn/index/interfaces/StepLabelProps)



Defined in: [src/narration/interfaces/StepLabelProps.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StepLabelProps.ts#L17)

StepLabelPropsType is the type of the props that will be passed to the StepLabel.
You can override this interface to add your own props.

## Default [#default]

```ts
{}
```

## Example [#example]

```ts
// pixi-vn.d.ts
declare module '@drincs/pixi-vn' {
    interface StepLabelProps {
        navigate: (route: string) => void,
        [key: string]: any
    }
}
```


# Interface: StepLabelResult (/pixi-vn/index/interfaces/StepLabelResult)



Defined in: [src/narration/interfaces/StepLabelResult.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StepLabelResult.ts#L18)

StepLabelResultType is the return type of the StepLabel function.
It can be useful for returning to the information calling function to perform other operations that cannot be performed within the StepLabel.
You can override this interface to add your own return types.

## Default [#default]

```ts
{}
```

## Example [#example]

```ts
// pixi-vn.d.ts
declare module '@drincs/pixi-vn' {
    interface StepLabelResult {
        newRoute?: string,
        [key: string]: any
    }
}
```


# Interface: StorageExternalStoreHandler (/pixi-vn/index/interfaces/StorageExternalStoreHandler)



Defined in: [src/storage/interfaces/StorageExternalStoreHandler.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageExternalStoreHandler.ts#L3)

## Properties [#properties]

### onClearOldTempVariable? [#onclearoldtempvariable]

\> `optional` **onClearOldTempVariable?**: (`key`) => `void`

Defined in: [src/storage/interfaces/StorageExternalStoreHandler.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageExternalStoreHandler.ts#L13)

Triggered when a temp variable is removed by [StorageRegistry.clearOldTempVariables](/pixi-vn/index/namespaces/StorageRegistry/functions/clearOldTempVariables).
The key is provided without any storage prefix.

#### Parameters [#parameters]

##### key [#key]

`string`

#### Returns [#returns]

`void`

***

### onRemoveVariable? [#onremovevariable]

\> `optional` **onRemoveVariable?**: (`key`) => `void`

Defined in: [src/storage/interfaces/StorageExternalStoreHandler.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageExternalStoreHandler.ts#L18)

Triggered when [StorageRegistry.removeVariable](/pixi-vn/index/namespaces/StorageRegistry/functions/removeVariable) is called.
The key is provided without any storage prefix.

#### Parameters [#parameters-1]

##### key [#key-1]

`string`

#### Returns [#returns-1]

`void`

***

### onSetVariable? [#onsetvariable]

\> `optional` **onSetVariable?**: (`key`, `value`) => `void`

Defined in: [src/storage/interfaces/StorageExternalStoreHandler.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageExternalStoreHandler.ts#L8)

Triggered when [StorageRegistry.setVariable](/pixi-vn/index/namespaces/StorageRegistry/functions/setVariable) is called.
The key is provided without any storage prefix.

#### Parameters [#parameters-2]

##### key [#key-2]

`string`

##### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

#### Returns [#returns-2]

`void`


# Interface: StorageFlagsInterface (/pixi-vn/index/interfaces/StorageFlagsInterface)



Defined in: [src/storage/interfaces/StorageFlagsInterface.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageFlagsInterface.ts#L1)

## Methods [#methods]

### get() [#get]

\> **get**(`key`): `boolean`

Defined in: [src/storage/interfaces/StorageFlagsInterface.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageFlagsInterface.ts#L13)

Get the value of a flag

#### Parameters [#parameters]

##### key [#key]

`string`

The name of the flag

#### Returns [#returns]

`boolean`

The value of the flag

***

### set() [#set]

\> **set**(`key`, `value`): `void`

Defined in: [src/storage/interfaces/StorageFlagsInterface.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageFlagsInterface.ts#L7)

Set a flag to true or false.

#### Parameters [#parameters-1]

##### key [#key-1]

`string`

The name of the flag

##### value [#value]

`boolean`

The value of the flag.

#### Returns [#returns-1]

`void`


# Interface: StorageGameState (/pixi-vn/index/interfaces/StorageGameState)



Defined in: [src/storage/interfaces/StorageGameState.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L11)

Interface exported storage data

## Properties [#properties]

### ~~base?~~ [#base]

\> `optional` **base?**: `StorageGameStateItem`\<[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)>\[]

Defined in: [src/storage/interfaces/StorageGameState.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L15)

#### Deprecated [#deprecated]

***

### ~~flags?~~ [#flags]

\> `optional` **flags?**: `string`\[]

Defined in: [src/storage/interfaces/StorageGameState.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L24)

#### Deprecated [#deprecated-1]

***

### main [#main]

\> **main**: `StorageGameStateItem`\<[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)>\[]

Defined in: [src/storage/interfaces/StorageGameState.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L25)

***

### ~~temp?~~ [#temp]

\> `optional` **temp?**: `StorageGameStateItem`\<[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)>\[]

Defined in: [src/storage/interfaces/StorageGameState.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L19)

#### Deprecated [#deprecated-2]

***

### tempDeadlines [#tempdeadlines]

\> **tempDeadlines**: `StorageGameStateItem`\<`number`>\[]

Defined in: [src/storage/interfaces/StorageGameState.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageGameState.ts#L20)


# Interface: StorageManagerInterface (/pixi-vn/index/interfaces/StorageManagerInterface)



Defined in: [src/storage/interfaces/StorageManagerInterface.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L8)

## Properties [#properties]

### base [#base]

\> `readonly` **base**: `Map`\<`string`, [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)>

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L26)

The internal storage. **Do not modify this directly.**

ATTENTION: If you edit this directly, the [cache](#cache) will not be updated.

You can use Keyv with Pixi’VN by creating a new instance of Keyv and passing the storage object as a parameter.

```ts
import { storage } from '@drincs/pixi-vn'
import Keyv from 'keyv';

const keyvStorage = new Keyv({ store: storage.base });

keyvStorage.get<string>("myValue").then((value) => {
    console.log(value);
});
```

***

### cache [#cache]

\> `readonly` **cache**: `LRUCache`\<`string`, `any`, `unknown`>

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L30)

The internal cache. **Do not modify this directly.**

***

### flags [#flags]

\> `readonly` **flags**: [`StorageFlagsInterface`](/pixi-vn/index/interfaces/StorageFlagsInterface)

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L93)

Namespace for operations on flags.

***

### temp [#temp]

\> `readonly` **temp**: [`StorageTempInterface`](/pixi-vn/index/interfaces/StorageTempInterface)

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L74)

Namespace for operations on temporary storage variables, whose lifespan is expressed in number of opened labels.

## Accessors [#accessors]

### default [#default]

#### Set Signature [#set-signature]

\> **set** **default**(`value`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:36](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L36)

Set the starting storage. The starting storage that will be used when the game starts.
**If variables are defined inside it, they can be edited during the game, but if you delete them, they will be restored to the starting storage.**
By default, the starting storage is empty.

##### Parameters [#parameters]

###### value [#value]

##### Returns [#returns]

`void`

## Methods [#methods]

### clear() [#clear]

\> **clear**(): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:132](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L132)

Clear the storage and the oidsUsed

#### Returns [#returns-1]

`void`

***

### export() [#export]

\> **export**(): `Promise`\<[`StorageGameState`](/pixi-vn/index/interfaces/StorageGameState)>

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:137](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L137)

Export the storage to an object

#### Returns [#returns-2]

`Promise`\<[`StorageGameState`](/pixi-vn/index/interfaces/StorageGameState)>

The object

***

### get() [#get]

\> **get**\<`T`>(`key`): `T` | `undefined`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L49)

Get a variable from the storage. If the variable is a temporary variable, it will return the temporary variable

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

#### Parameters [#parameters-1]

##### key [#key]

`string`

The key of the variable

#### Returns [#returns-3]

`T` | `undefined`

The value of the variable. If the variable does not exist, it will return undefined

***

### ~~getFlag()~~ [#getflag]

\> **getFlag**(`key`): `boolean`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:89](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L89)

Get the value of a flag

#### Parameters [#parameters-2]

##### key [#key-1]

`string`

The name of the flag

#### Returns [#returns-4]

`boolean`

The value of the flag

#### Deprecated [#deprecated]

Use [flags](#flags).get instead.

***

### remove() [#remove]

\> **remove**(`key`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L55)

Remove a variable from the storage

#### Parameters [#parameters-3]

##### key [#key-2]

`string`

The key of the variable

#### Returns [#returns-5]

`void`

***

### ~~removeTempVariable()~~ [#removetempvariable]

\> **removeTempVariable**(`key`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:70](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L70)

Remove a temporary variable

#### Parameters [#parameters-4]

##### key [#key-3]

`string`

The key of the temporary variable

#### Returns [#returns-6]

`void`

#### Deprecated [#deprecated-1]

Use [temp](#temp).remove instead.

***

### restore() [#restore]

\> **restore**(`data`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:142](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L142)

Restore the storage from an object

#### Parameters [#parameters-5]

##### data [#data]

[`StorageGameState`](/pixi-vn/index/interfaces/StorageGameState)

The object

#### Returns [#returns-7]

`void`

***

### set() [#set]

\> **set**(`key`, `value`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L43)

Set a variable in the storage

#### Parameters [#parameters-6]

##### key [#key-4]

`string`

The key of the variable

##### value [#value-1]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value of the variable. If undefined, the variable will be removed

#### Returns [#returns-8]

`void`

***

### ~~setFlag()~~ [#setflag]

\> **setFlag**(`key`, `value`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:82](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L82)

Set a flag to true or false.

#### Parameters [#parameters-7]

##### key [#key-5]

`string`

The name of the flag

##### value [#value-2]

`boolean`

The value of the flag.

#### Returns [#returns-9]

`void`

#### Deprecated [#deprecated-2]

Use [flags](#flags).set instead.

***

### setStorageHandler() [#setstoragehandler]

\> **setStorageHandler**(`value?`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:127](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L127)

Configure the handler used to mirror game storage changes into an external reactive store.
Call this at any time to start/stop mirroring.

#### Parameters [#parameters-8]

##### value? [#value-3]

[`StorageExternalStoreHandler`](/pixi-vn/index/interfaces/StorageExternalStoreHandler)

The handler to set. If undefined, the handler will be removed.

#### Returns [#returns-10]

`void`

#### Example [#example]

```ts
import { Store } from '@tanstack/store'

// Create a TanStack store that mirrors the game storage variables
const gameStore = new Store<Record<string, unknown>>({})

storage.setStorageHandler({
    onSetVariable: (key, value) => {
        gameStore.setState((state) => ({ ...state, [key]: value }))
    },
    onRemoveVariable: (key) => {
        gameStore.setState((state) => {
            const next = { ...state }
            delete next[key]
            return next
        })
    },
    onClearOldTempVariable: (key) => {
        gameStore.setState((state) => {
            const next = { ...state }
            delete next[key]
            return next
        })
    },
})
```

***

### ~~setTempVariable()~~ [#settempvariable]

\> **setTempVariable**(`key`, `value`): `void`

Defined in: [src/storage/interfaces/StorageManagerInterface.ts:64](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageManagerInterface.ts#L64)

Set a variable in the temporary storage. The lifespan of the variable is the number of opened labels.
To get the temporary variable, use [get](#get)

#### Parameters [#parameters-9]

##### key [#key-6]

`string`

The key of the temporary variable

##### value [#value-4]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value of the temporary variable. If undefined, the variable will be removed

#### Returns [#returns-11]

`void`

#### Deprecated [#deprecated-3]

Use [temp](#temp).set instead.


# Interface: StorageTempInterface (/pixi-vn/index/interfaces/StorageTempInterface)



Defined in: [src/storage/interfaces/StorageTempInterface.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageTempInterface.ts#L3)

## Properties [#properties]

### deadlines [#deadlines]

\> `readonly` **deadlines**: `Map`\<`string`, `number`>

Defined in: [src/storage/interfaces/StorageTempInterface.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageTempInterface.ts#L20)

The deadlines of the temporary variables, expressed as the number of opened labels after which
each variable will be removed. **Do not modify this directly.**

## Methods [#methods]

### remove() [#remove]

\> **remove**(`key`): `void`

Defined in: [src/storage/interfaces/StorageTempInterface.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageTempInterface.ts#L15)

Remove a temporary variable

#### Parameters [#parameters]

##### key [#key]

`string`

The key of the temporary variable

#### Returns [#returns]

`void`

***

### set() [#set]

\> **set**(`key`, `value`): `void`

Defined in: [src/storage/interfaces/StorageTempInterface.ts:10](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/interfaces/StorageTempInterface.ts#L10)

Set a variable in the temporary storage. The lifespan of the variable is the number of opened labels.
To get the temporary variable, use [StorageManagerInterface.get](/pixi-vn/index/interfaces/StorageManagerInterface#get)

#### Parameters [#parameters-1]

##### key [#key-1]

`string`

The key of the temporary variable

##### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

The value of the temporary variable. If undefined, the variable will be removed

#### Returns [#returns-1]

`void`


# Interface: SwayEffectProps (/pixi-vn/index/interfaces/SwayEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:119](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L119)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), SwayEffectProps):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:130](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L130)

The rotational drift (in degrees) away from the component's current angle, on the first
repetition.

#### Default [#default-1]

```ts
5
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### axis? [#axis]

\> `optional` **axis?**: `"horizontal"` | `"vertical"`

Defined in: [src/canvas/interfaces/effect-props.ts:135](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L135)

The axis the positional drift moves along.

#### Default [#default-2]

```ts
"horizontal"
```

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-3]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-4]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-5]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### distance? [#distance]

\> `optional` **distance?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:124](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L124)

The distance (in pixels) of the positional drift, on the first repetition.

#### Default [#default-6]

```ts
10
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-7]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### repetitions? [#repetitions]

\> `optional` **repetitions?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:140](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L140)

The number of repetitions.

#### Default [#default-8]

```ts
3
```

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-9]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: TextMemory (/pixi-vn/index/interfaces/TextMemory)



Defined in: [src/canvas/interfaces/memory/TextMemory.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/TextMemory.ts#L9)

Interface for the canvas text memory

## Extends [#extends]

* `TextOptions`.[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`TextOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`TextOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`TextOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`TextOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`TextOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`TextOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`TextOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

`TextOptions.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:136

The anchor point of the text that controls the origin point for positioning and rotation.
Can be a number (same value for x/y) or a PointData object.

* (0,0) is top-left
* (0.5,0.5) is center
* (1,1) is bottom-right

```ts
// Set anchor to center
const text = new Text({
    text: 'Hello Pixi!',
    anchor: 0.5 // Same as { x: 0.5, y: 0.5 }
});
// Set anchor to top-left
const text2 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 0, y: 0 } // Top-left corner
});
// Set anchor to bottom-right
const text3 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 1, y: 1 } // Bottom-right corner
});
```

#### Default [#default-8]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-9]

`TextOptions.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`TextOptions.angle`

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

`TextOptions.autoGarbageCollect`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

`TextOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

`TextOptions.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

`TextOptions.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

`TextOptions.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

`TextOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

`TextOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

`TextOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

`TextOptions.cursor`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

`TextOptions.eventMode`

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

`TextOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

`TextOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

`TextOptions.hitArea`

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`index`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

`TextOptions.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

`TextOptions.interactiveChildren`

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

`TextOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`label`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`TextOptions.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-29]

`TextOptions.onclick`

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-30]

[`ListenerExtensionMemory`](/pixi-vn/index/interfaces/ListenerExtensionMemory).[`onEvents`](/pixi-vn/index/interfaces/ListenerExtensionMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

`TextOptions.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

`TextOptions.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-33]

`TextOptions.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-34]

`TextOptions.onmousedown`

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-35]

`TextOptions.onmouseenter`

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-36]

`TextOptions.onmouseleave`

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-37]

`TextOptions.onmousemove`

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-38]

`TextOptions.onmouseout`

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-39]

`TextOptions.onmouseover`

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-40]

`TextOptions.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-41]

`TextOptions.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-42]

`TextOptions.onpointercancel`

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-43]

`TextOptions.onpointerdown`

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-44]

`TextOptions.onpointerenter`

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-45]

`TextOptions.onpointerleave`

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-46]

`TextOptions.onpointermove`

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-47]

`TextOptions.onpointerout`

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-48]

`TextOptions.onpointerover`

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-49]

`TextOptions.onpointertap`

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-50]

`TextOptions.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-51]

`TextOptions.onpointerupoutside`

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-52]

`TextOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-53]

`TextOptions.onrightclick`

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-54]

`TextOptions.onrightdown`

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-55]

`TextOptions.onrightup`

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-56]

`TextOptions.onrightupoutside`

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-57]

`TextOptions.ontap`

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-58]

`TextOptions.ontouchcancel`

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-59]

`TextOptions.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-60]

`TextOptions.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-61]

`TextOptions.ontouchmove`

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-62]

`TextOptions.ontouchstart`

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-63]

`TextOptions.onwheel`

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-64]

`TextOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-65]

`TextOptions.parent`

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-66]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`parentLabel`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#parentlabel)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-70]

`TextOptions.pivot`

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-71]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-72]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`pixivnId`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-73]

`TextOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-74]

`TextOptions.renderable`

***

### resolution? [#resolution]

> `optional` **resolution?**: `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:175

The resolution/device pixel ratio for rendering.
Higher values result in sharper text at the cost of performance.
Set to null for auto-resolution based on device.

#### Example [#example-60]

```ts
const text = new Text({
    text: 'Hello Pixi!',
    resolution: 2 // High DPI for sharper text
});
const autoResText = new Text({
    text: 'Auto Resolution',
    resolution: null // Use device's pixel ratio
});
```

#### Default [#default-51]

```ts
null
```

#### Inherited from [#inherited-from-75]

`TextOptions.resolution`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-76]

`TextOptions.rotation`

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:225

Whether to round the x/y position to whole pixels.
Enabling can prevent anti-aliasing of text edges but may cause slight position shifting.

#### Example [#example-62]

````ts
const text = new Text({
    text: 'Rounded Text',
    roundPixels: true // Rounds position to whole pixels
});
@default false

#### Inherited from

`TextOptions.roundPixels`

***

### scale?

&gt; `optional` **scale?**: `number` \| `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
````

#### Inherited from [#inherited-from-77]

`TextOptions.scale`

***

### setMask? [#setmask]

\> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-78]

`TextOptions.setMask`

***

### skew? [#skew]

\> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-63]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-79]

`TextOptions.skew`

***

### sortableChildren? [#sortablechildren]

\> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-64]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-80]

`TextOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

\> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-81]

`TextOptions.sortDirty`

***

### style? [#style]

\> `optional` **style?**: `TextStyle` | `TextStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:213

The style configuration for the text.
Can be a TextStyle instance or a configuration object.
Supports canvas text styles, HTML text styles, and bitmap text styles.

#### Example [#example-65]

````ts
const text = new Text({
    text: 'Styled Text',
    style: {
        fontSize: 24,
        fill: 0xff1010, // Red color
        fontFamily: 'Arial',
        align: 'center', // Center alignment
        stroke: { color: '#4a1850', width: 5 }, // Purple stroke
        dropShadow: {
            color: '#000000', // Black shadow
            blur: 4, // Shadow blur
            distance: 6 // Shadow distance
        }
    }
});
const htmlText = new HTMLText({
    text: 'HTML Styled Text',
    style: {
        fontSize: '20px',
        fill: 'blue',
        fontFamily: 'Verdana',
    }
});
const bitmapText = new BitmapText({
    text: 'Bitmap Styled Text',
    style: {
        fontName: 'Arial',
        fontSize: 32,
    }
})

#### Inherited from

`TextOptions.style`

***

### tabIndex?

> `optional` **tabIndex?**: `number`

Defined in: node\_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default

```ts
0
````

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-82]

`TextOptions.tabIndex`

***

### text? [#text]

> `optional` **text?**: `TextString`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:157

The text content to display. Use '\n' for line breaks.
Accepts strings, numbers, or objects with toString() method.

#### Example [#example-67]

```ts
const text = new Text({
    text: 'Hello Pixi!',
});
const multilineText = new Text({
    text: 'Line 1\nLine 2\nLine 3',
});
const numberText = new Text({
    text: 12345, // Will be converted to '12345'
});
const objectText = new Text({
    text: { toString: () =&gt; 'Object Text' }, // Custom toString
});
```

#### Default [#default-55]

```ts
''
```

#### Inherited from [#inherited-from-83]

`TextOptions.text`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-56]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-84]

`TextOptions.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-57]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-85]

`TextOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-58]

```ts
0
```

#### Inherited from [#inherited-from-86]

`TextOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-87]

`TextOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-88]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-89]

`TextOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-90]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-91]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory).[`zIndex`](/pixi-vn/index/interfaces/CanvasBaseItemMemory#zindex)


# Interface: TextOptions (/pixi-vn/index/interfaces/TextOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L17)

## Extends [#extends]

* `Omit`\<`CanvasTextOptions`, `"on"`>.[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`Omit.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`Omit.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`Omit.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`Omit.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`Omit.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`Omit.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`Omit.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`align`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:136

The anchor point of the text that controls the origin point for positioning and rotation.
Can be a number (same value for x/y) or a PointData object.

* (0,0) is top-left
* (0.5,0.5) is center
* (1,1) is bottom-right

```ts
// Set anchor to center
const text = new Text({
    text: 'Hello Pixi!',
    anchor: 0.5 // Same as { x: 0.5, y: 0.5 }
});
// Set anchor to top-left
const text2 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 0, y: 0 } // Top-left corner
});
// Set anchor to bottom-right
const text3 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 1, y: 1 } // Bottom-right corner
});
```

#### Default [#default-8]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-9]

`Omit.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/ImageSpriteMemory#autogarbagecollect)

***

### autoGenerateMipmaps? [#autogeneratemipmaps]

\> `optional` **autoGenerateMipmaps?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:62

Whether to generate mipmaps for the text texture.
Improves rendering quality when the text is scaled down.

#### Default [#default-9]

```ts
undefined - Falls back to TextureSource.defaultOptions.autoGenerateMipmaps
```

#### Inherited from [#inherited-from-12]

`Omit.autoGenerateMipmaps`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-10]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-13]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-14]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-15]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-16]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-11]

```ts
false
```

#### Inherited from [#inherited-from-17]

`Omit.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-12]

```ts
true
```

#### Inherited from [#inherited-from-18]

`Omit.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-19]

`Omit.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-14]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-20]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-21]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-22]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-15]

```ts
0
```

#### Inherited from [#inherited-from-23]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-16]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-18]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-21]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-51]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-50]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-63]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-64]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentagePosition`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageX`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`percentageY`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-51]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### resolution? [#resolution]

> `optional` **resolution?**: `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:175

The resolution/device pixel ratio for rendering.
Higher values result in sharper text at the cost of performance.
Set to null for auto-resolution based on device.

#### Example [#example-60]

```ts
const text = new Text({
    text: 'Hello Pixi!',
    resolution: 2 // High DPI for sharper text
});
const autoResText = new Text({
    text: 'Auto Resolution',
    resolution: null // Use device's pixel ratio
});
```

#### Default [#default-52]

```ts
null
```

#### Inherited from [#inherited-from-71]

`Omit.resolution`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:225

Whether to round the x/y position to whole pixels.
Enabling can prevent anti-aliasing of text edges but may cause slight position shifting.

#### Example [#example-62]

````ts
const text = new Text({
    text: 'Rounded Text',
    roundPixels: true // Rounds position to whole pixels
});
@default false

#### Inherited from

`Omit.roundPixels`

***

### scale?

&gt; `optional` **scale?**: `number` \| `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
````

#### Inherited from [#inherited-from-73]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

\> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-74]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

\> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-63]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-53]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-75]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

\> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-64]

```ts
container.sortableChildren = true;
```

#### Default [#default-54]

```ts
false
```

#### Inherited from [#inherited-from-76]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

\> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-55]

```ts
false
@internal
```

#### Inherited from [#inherited-from-77]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### style? [#style]

\> `optional` **style?**: `TextStyle` | `TextStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:213

The style configuration for the text.
Can be a TextStyle instance or a configuration object.
Supports canvas text styles, HTML text styles, and bitmap text styles.

#### Example [#example-65]

````ts
const text = new Text({
    text: 'Styled Text',
    style: {
        fontSize: 24,
        fill: 0xff1010, // Red color
        fontFamily: 'Arial',
        align: 'center', // Center alignment
        stroke: { color: '#4a1850', width: 5 }, // Purple stroke
        dropShadow: {
            color: '#000000', // Black shadow
            blur: 4, // Shadow blur
            distance: 6 // Shadow distance
        }
    }
});
const htmlText = new HTMLText({
    text: 'HTML Styled Text',
    style: {
        fontSize: '20px',
        fill: 'blue',
        fontFamily: 'Verdana',
    }
});
const bitmapText = new BitmapText({
    text: 'Bitmap Styled Text',
    style: {
        fontName: 'Arial',
        fontSize: 32,
    }
})

#### Inherited from

`Omit.style`

***

### tabIndex?

> `optional` **tabIndex?**: `number`

Defined in: node\_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default

```ts
0
````

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-78]

`Omit.tabIndex`

***

### text? [#text]

> `optional` **text?**: `TextString`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:157

The text content to display. Use '\n' for line breaks.
Accepts strings, numbers, or objects with toString() method.

#### Example [#example-67]

```ts
const text = new Text({
    text: 'Hello Pixi!',
});
const multilineText = new Text({
    text: 'Line 1\nLine 2\nLine 3',
});
const numberText = new Text({
    text: 12345, // Will be converted to '12345'
});
const objectText = new Text({
    text: { toString: () =&gt; 'Object Text' }, // Custom toString
});
```

#### Default [#default-56]

```ts
''
```

#### Inherited from [#inherited-from-79]

`Omit.text`

***

### textureStyle? [#texturestyle]

> `optional` **textureStyle?**: `TextureStyleOptions` | `TextureStyle`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:56

Optional texture style for the text texture. Only `scaleMode` is read (`nearest` or `linear`):
the text gets a pooled texture with that scale mode. Every other field is ignored.

#### Example [#example-68]

```ts
const text = new Text({
    text: 'Crisp Text',
    textureStyle: {
        scaleMode: 'nearest', // Pixel-perfect scaling
    }
});
```

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-80]

`Omit.textureStyle`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-69]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-81]

`Omit.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-70]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-82]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-71]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-83]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-72]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-84]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`xAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-73]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-86]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-87]

[`AdditionalPositionsExtensionProps`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps).[`yAlign`](/pixi-vn/index/interfaces/AdditionalPositionsExtensionProps#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-74]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-88]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: Ticker<TArgs> (/pixi-vn/index/interfaces/Ticker)



Defined in: [src/tickers/interfaces/Ticker.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L5)

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

## Properties [#properties]

### alias [#alias]

\> `readonly` **alias**: `string`

Defined in: [src/tickers/interfaces/Ticker.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L21)

Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, [RegisteredTickers.getInstance](/pixi-vn/index/namespaces/RegisteredTickers/functions/getInstance)

***

### args [#args]

\> **args**: `TArgs`

Defined in: [src/tickers/interfaces/Ticker.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L9)

Arguments to pass to the ticker

***

### canvasElementAliases [#canvaselementaliases]

\> **canvasElementAliases**: `string`\[]

Defined in: [src/tickers/interfaces/Ticker.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L29)

The aliases of the canvas elements that are connected to this ticker

***

### complete [#complete]

\> **complete**: (`options?`) => `void` | `Promise`\<`void`>

Defined in: [src/tickers/interfaces/Ticker.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L33)

Completes the animation and applies the final state.

#### Parameters [#parameters]

##### options? [#options]

###### ignoreTickerSteps? [#ignoretickersteps]

`boolean`

#### Returns [#returns]

`void` | `Promise`\<`void`>

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: [src/tickers/interfaces/Ticker.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L13)

Duration in seconds to run the ticker

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/tickers/interfaces/Ticker.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L25)

The id of the ticker. Must be unique for each ticker instance.

***

### pause [#pause]

\> **pause**: () => `void`

Defined in: [src/tickers/interfaces/Ticker.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L45)

Pauses the animation.

#### Returns [#returns-1]

`void`

***

### paused [#paused]

\> `readonly` **paused**: `boolean`

Defined in: [src/tickers/interfaces/Ticker.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L54)

Checks if the ticker is paused.

#### Returns [#returns-2]

true if the ticker is paused, false otherwise.

***

### play [#play]

\> **play**: () => `void`

Defined in: [src/tickers/interfaces/Ticker.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L49)

Plays the animation.

#### Returns [#returns-3]

`void`

***

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/tickers/interfaces/Ticker.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L17)

Priority of the ticker

***

### start [#start]

\> **start**: () => `void`

Defined in: [src/tickers/interfaces/Ticker.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L41)

Starts the ticker. This will start the ticker and begin the animation.

#### Returns [#returns-4]

`void`

***

### stop [#stop]

\> **stop**: () => `void`

Defined in: [src/tickers/interfaces/Ticker.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/Ticker.ts#L37)

Stops the animation at its current state, and prevents it from resuming when the animation is played again.

#### Returns [#returns-5]

`void`


# Interface: TickerArgs (/pixi-vn/index/interfaces/TickerArgs)



Defined in: [src/tickers/interfaces/TickerArgs.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerArgs.ts#L2)


# Interface: TickerHistory<TArgs> (/pixi-vn/index/interfaces/TickerHistory)



Defined in: [src/tickers/interfaces/TickerInfo.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L19)

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

## Properties [#properties]

### args [#args]

\> **args**: `TArgs`

Defined in: [src/tickers/interfaces/TickerInfo.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L21)

***

### canvasElementAliases [#canvaselementaliases]

\> **canvasElementAliases**: `string`\[]

Defined in: [src/tickers/interfaces/TickerInfo.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L25)

The aliases of the canvas elements that are connected to this ticker

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: [src/tickers/interfaces/TickerInfo.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L27)

***

### id [#id]

\> **id**: `string`

Defined in: [src/tickers/interfaces/TickerInfo.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L20)

***

### paused? [#paused]

\> `optional` **paused?**: `boolean`

Defined in: [src/tickers/interfaces/TickerInfo.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L28)

***

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/tickers/interfaces/TickerInfo.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L26)


# Interface: TickerInfo<TArgs> (/pixi-vn/index/interfaces/TickerInfo)



Defined in: [src/tickers/interfaces/TickerInfo.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L8)

TickerHistory is a class that contains the name of a class and the arguments that were used to create it.

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

## Properties [#properties]

### createdByTicketSteps? [#createdbyticketsteps]

\> `optional` **createdByTicketSteps?**: `object`

Defined in: [src/tickers/interfaces/TickerInfo.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L12)

If this ticker was created by steps

#### canvasElementAlias [#canvaselementalias]

\> **canvasElementAlias**: `string`

#### id [#id]

\> **id**: `string`

***

### ticker [#ticker]

\> **ticker**: [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`>

Defined in: [src/tickers/interfaces/TickerInfo.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerInfo.ts#L16)


# Interface: TickerProgrationExponential (/pixi-vn/index/interfaces/TickerProgrationExponential)



Defined in: [src/tickers/interfaces/TickerProgrationType.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L14)

## Properties [#properties]

### limit? [#limit]

\> `optional` **limit?**: `number`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L22)

The limit of the effect

***

### percentage [#percentage]

\> **percentage**: `number`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:18](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L18)

The percentage of the speed to increase every frame. if the percentage is 0.1, the speed will increase by 10% every frame.

***

### type [#type]

\> **type**: `"exponential"`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L23)


# Interface: TickerProgrationLinear (/pixi-vn/index/interfaces/TickerProgrationLinear)



Defined in: [src/tickers/interfaces/TickerProgrationType.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L3)

## Properties [#properties]

### amt [#amt]

\> **amt**: `number`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L7)

The amount of the speed to increase every frame.

***

### limit? [#limit]

\> `optional` **limit?**: `number`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L11)

The limit of the effect

***

### type [#type]

\> **type**: `"linear"`

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L12)


# Interface: TickerTimeoutHistory (/pixi-vn/index/interfaces/TickerTimeoutHistory)



Defined in: [src/tickers/interfaces/TickerTimeoutHistory.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerTimeoutHistory.ts#L1)

## Properties [#properties]

### aliases [#aliases]

\> **aliases**: `string`\[]

Defined in: [src/tickers/interfaces/TickerTimeoutHistory.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerTimeoutHistory.ts#L2)

***

### canBeDeletedBeforeEnd [#canbedeletedbeforeend]

\> **canBeDeletedBeforeEnd**: `boolean`

Defined in: [src/tickers/interfaces/TickerTimeoutHistory.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerTimeoutHistory.ts#L4)

***

### ticker [#ticker]

\> **ticker**: `string`

Defined in: [src/tickers/interfaces/TickerTimeoutHistory.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerTimeoutHistory.ts#L3)


# Interface: TickerValue (/pixi-vn/index/interfaces/TickerValue)



Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:67

A Ticker class that runs an update loop that other objects listen to.
Used for managing animation frames and timing in a PixiJS application.

It provides a way to add listeners that will be called on each frame,
allowing for smooth animations and updates.

## Time Units [#time-units]

* `deltaTime`: Dimensionless scalar (typically \~1.0 at 60 FPS) for frame-independent animations
* `deltaMS`: Milliseconds elapsed (capped and speed-scaled) for time-based calculations
* `elapsedMS`: Raw milliseconds elapsed (uncapped, unscaled) for measurements
* `lastTime`: Timestamp in milliseconds since epoch (performance.now() format)

Animation frames are requested
only when necessary, e.g., when the ticker is started and the emitter has listeners.

## Example [#example]

```ts
// Basic ticker usage with different time units
const ticker = new Ticker();
ticker.add((ticker) => {
    // Frame-independent animation using dimensionless deltaTime
    sprite.rotation += 0.1 * ticker.deltaTime;

    // Time-based animation using deltaMS (milliseconds)
    sprite.x += (100 / 1000) * ticker.deltaMS; // 100 pixels per second
});
ticker.start();

// Control update priority
ticker.add(
    (ticker) => {
        // High priority updates run first
        physics.update(ticker.deltaTime);
    },
    undefined,
    UPDATE_PRIORITY.HIGH
);

// One-time updates
ticker.addOnce(() => {
    console.log('Runs on next frame only');
});
```

## See [#see]

* TickerPlugin For use with Application
* [UPDATE_PRIORITY](/pixi-vn/index/variables/UPDATE_PRIORITY) For priority constants
* TickerCallback For listener function type

## Standard [#standard]

## Properties [#properties]

### autoStart [#autostart]

\> **autoStart**: `boolean`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:118

Whether or not this ticker should invoke the method [start](#start)
automatically when a listener is added.

#### Example [#example-1]

```ts
// Default behavior (manual start)
const ticker = new Ticker();
ticker.autoStart = false;
ticker.add(() => {
    // Won't run until ticker.start() is called
});

// Auto-start behavior
const autoTicker = new Ticker();
autoTicker.autoStart = true;
autoTicker.add(() => {
    // Runs immediately when added
});
```

#### Default [#default]

```ts
false
```

#### See [#see-1]

* [Ticker#start](#start) For manually starting the ticker
* [Ticker#stop](#stop) For manually stopping the ticker

***

### deltaMS [#deltams]

\> **deltaMS**: `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:160

Scalar time elapsed in milliseconds from last frame to this frame.
Provides precise timing for animations and updates.

This value is capped by setting [minFPS](#minfps)
and is scaled with [speed](#speed).

If the platform supports DOMHighResTimeStamp,
this value will have a precision of 1 µs.

Defaults to target frame time

\> \[!NOTE] The cap may be exceeded by scaling.

#### Example [#example-2]

```ts
// Animation timing
ticker.add((ticker) => {
    // Use millisecond timing for precise animations
    const progress = (ticker.deltaMS / animationDuration);
    sprite.alpha = Math.min(1, progress);
});
```

#### Default [#default-1]

```ts
16.66
```

***

### deltaTime [#deltatime]

\> **deltaTime**: `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:135

Scalar representing the delta time factor.
This is a dimensionless value representing the fraction of a frame at the target framerate.
At 60 FPS, this value is typically around 1.0.

This is NOT in milliseconds - it's a scalar multiplier for frame-independent animations.
For actual milliseconds, use [Ticker#deltaMS](#deltams).

#### Example [#example-3]

```ts
// Frame-independent animation using deltaTime scalar
ticker.add((ticker) => {
    // Rotate sprite by 0.1 radians per frame, scaled by deltaTime
    sprite.rotation += 0.1 * ticker.deltaTime;
});
```

***

### elapsedMS [#elapsedms]

\> **elapsedMS**: `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:173

Time elapsed in milliseconds from the last frame to this frame.
This value is not capped or scaled and provides raw timing information.

Unlike [Ticker#deltaMS](#deltams), this value is unmodified by speed scaling or FPS capping.

#### Example [#example-4]

```ts
ticker.add((ticker) => {
    console.log(`Raw frame time: ${ticker.elapsedMS}ms`);
});
```

***

### lastTime [#lasttime]

\> **lastTime**: `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:188

The last time update was invoked, in milliseconds since epoch.
Similar to performance.now() timestamp format.

Used internally for calculating time deltas between frames.

#### Example [#example-5]

```ts
ticker.add((ticker) => {
    const currentTime = performance.now();
    const timeSinceLastFrame = currentTime - ticker.lastTime;
    console.log(`Time since last frame: ${timeSinceLastFrame}ms`);
});
```

***

### speed [#speed]

\> **speed**: `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:208

Factor of current [deltaTime](#deltatime).
Used to scale time for slow motion or fast-forward effects.

#### Example [#example-6]

```ts
// Basic speed adjustment
ticker.speed = 0.5; // Half speed (slow motion)
ticker.speed = 2.0; // Double speed (fast forward)

// Temporary speed changes
function slowMotion() {
    const normalSpeed = ticker.speed;
    ticker.speed = 0.2;
    setTimeout(() => {
        ticker.speed = normalSpeed;
    }, 1000);
}
```

***

### started [#started]

\> **started**: `boolean`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:229

Whether or not this ticker has been started.

`true` if [start](#start) has been called.
`false` if [Stop](#stop) has been called.

While `false`, this value may change to `true` in the
event of [autoStart](#autostart) being `true`
and a listener is added.

#### Example [#example-7]

```ts
// Check ticker state
const ticker = new Ticker();
console.log(ticker.started); // false

// Start and verify
ticker.start();
console.log(ticker.started); // true
```

## Accessors [#accessors]

### count [#count]

#### Get Signature [#get-signature]

\> **get** **count**(): `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:397

The number of listeners on this ticker, calculated by walking through linked list.

##### Example [#example-8]

```ts
// Check number of active listeners
const ticker = new Ticker();
console.log(ticker.count); // 0

// Add some listeners
ticker.add(() => {});
ticker.add(() => {});
console.log(ticker.count); // 2

// Check after cleanup
ticker.destroy();
console.log(ticker.count); // 0
```

##### See [#see-2]

* [Ticker#add](#add) For adding listeners
* [Ticker#remove](#remove) For removing listeners

##### Returns [#returns]

`number`

***

### FPS [#fps]

#### Get Signature [#get-signature-1]

\> **get** **FPS**(): `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:479

The frames per second at which this ticker is running.
The default is approximately 60 in most modern browsers.
\> \[!NOTE] This does not factor in the value of
\> [speed](#speed), which is specific
\> to scaling [deltaTime](#deltatime).

##### Example [#example-9]

```ts
// Basic FPS monitoring
ticker.add(() => {
    console.log(`Current FPS: ${Math.round(ticker.FPS)}`);
});
```

##### Returns [#returns-1]

`number`

***

### maxFPS [#maxfps]

#### Get Signature [#get-signature-2]

\> **get** **maxFPS**(): `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:535

Manages the minimum amount of milliseconds required to
elapse between invoking [update](#update).

This will effect the measured value of [FPS](#fps).

If it is set to `0`, then there is no limit; PixiJS will render as many frames as it can.
Otherwise it will be at least `minFPS`.

If `maxFPS` is set below the current `minFPS`, `minFPS` is automatically lowered to match.
This keeps the two limits consistent.

##### Example [#example-10]

```ts
// Cap the frame rate
const ticker = new Ticker();
ticker.maxFPS = 60; // Never go above 60 FPS

// Use with minFPS for frame rate clamping
ticker.minFPS = 30;
ticker.maxFPS = 60;

// maxFPS below minFPS pushes minFPS down
ticker.maxFPS = 20; // minFPS is now also 20
```

##### Default [#default-2]

```ts
0
```

##### Returns [#returns-2]

`number`

#### Set Signature [#set-signature]

\> **set** **maxFPS**(`fps`): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:536

##### Parameters [#parameters]

###### fps [#fps-1]

`number`

##### Returns [#returns-3]

`void`

***

### minFPS [#minfps]

#### Get Signature [#get-signature-3]

\> **get** **minFPS**(): `number`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:507

Manages the maximum amount of milliseconds allowed to
elapse between invoking [update](#update).

This value is used to cap [deltaTime](#deltatime),
but does not effect the measured value of [FPS](#fps).

When setting this property it is clamped to a value between
`0` and `Ticker.targetFPMS * 1000` (typically 60).

If `maxFPS` is currently set (non-zero) and `minFPS` is set above it,
`maxFPS` is automatically raised to match. This keeps the two limits consistent.

##### Example [#example-11]

```ts
// Set minimum acceptable frame rate
const ticker = new Ticker();
ticker.minFPS = 30; // Never go below 30 FPS

// Use with maxFPS for frame rate clamping
ticker.minFPS = 30;
ticker.maxFPS = 60;

// minFPS above maxFPS pushes maxFPS up
ticker.minFPS = 50; // maxFPS is raised to 50
```

##### Default [#default-3]

```ts
10
```

##### Returns [#returns-4]

`number`

#### Set Signature [#set-signature-1]

\> **set** **minFPS**(`fps`): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:508

##### Parameters [#parameters-1]

###### fps [#fps-2]

`number`

##### Returns [#returns-5]

`void`

## Methods [#methods]

### add() [#add]

\> **add**\<`T`>(`fn`, `context?`, `priority?`): `this`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:296

Register a handler for tick events.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `any`

#### Parameters [#parameters-2]

##### fn [#fn]

`TickerCallback`\<`T`>

The listener function to add. Receives the Ticker instance as parameter

##### context? [#context]

`T`

The context for the listener

##### priority? [#priority]

`number`

The priority of the listener

#### Returns [#returns-6]

`this`

#### Example [#example-12]

```ts
// Access time properties through the ticker parameter
ticker.add((ticker) => {
    // Use deltaTime (dimensionless scalar) for frame-independent animations
    sprite.rotation += 0.1 * ticker.deltaTime;

    // Use deltaMS (milliseconds) for time-based calculations
    const progress = ticker.deltaMS / animationDuration;

    // Use elapsedMS for raw timing measurements
    console.log(`Raw frame time: ${ticker.elapsedMS}ms`);
});
```

***

### addOnce() [#addonce]

\> **addOnce**\<`T`>(`fn`, `context?`, `priority?`): `this`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:332

Add a handler for the tick event which is only executed once on the next frame.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` = `any`

#### Parameters [#parameters-3]

##### fn [#fn-1]

`TickerCallback`\<`T`>

The listener function to be added for one update

##### context? [#context-1]

`T`

The listener context

##### priority? [#priority-1]

`number`

The priority for emitting (default: UPDATE_PRIORITY.NORMAL)

#### Returns [#returns-7]

`this`

This instance of a ticker

#### Example [#example-13]

```ts
// Basic one-time update
ticker.addOnce(() => {
    console.log('Runs next frame only');
});

// With specific context
const game = {
    init(ticker) {
        this.loadResources();
        console.log('Game initialized');
    }
};
ticker.addOnce(game.init, game);

// With priority
ticker.addOnce(
    () => {
        // High priority one-time setup
        physics.init();
    },
    undefined,
    UPDATE_PRIORITY.HIGH
);
```

#### See [#see-3]

* [Ticker#add](#add) For continuous updates
* [Ticker#remove](#remove) For removing handlers

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:439

Destroy the ticker and don't use after this. Calling this method removes all references to internal events.

#### Returns [#returns-8]

`void`

#### Example [#example-14]

```ts
// Clean up with active listeners
const ticker = new Ticker();
ticker.add(() => {});
ticker.destroy(); // Removes all listeners
```

#### See [#see-4]

* [Ticker#stop](#stop) For stopping without destroying
* [Ticker#remove](#remove) For removing specific listeners

***

### remove() [#remove]

\> **remove**\<`T`>(`fn`, `context?`): `this`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:375

Removes any handlers matching the function and context parameters.
If no handlers are left after removing, then it cancels the animation frame.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` = `any`

#### Parameters [#parameters-4]

##### fn [#fn-2]

`TickerCallback`\<`T`>

The listener function to be removed

##### context? [#context-2]

`T`

The listener context to be removed

#### Returns [#returns-9]

`this`

This instance of a ticker

#### Example [#example-15]

```ts
// Basic removal
const onTick = () => {
    sprite.rotation += 0.1;
};
ticker.add(onTick);
ticker.remove(onTick);

// Remove with context
const game = {
    update(ticker) {
        this.physics.update(ticker.deltaTime);
    }
};
ticker.add(game.update, game);
ticker.remove(game.update, game);

// Remove all matching handlers
// (if same function was added multiple times)
ticker.add(onTick);
ticker.add(onTick);
ticker.remove(onTick); // Removes all instances
```

#### See [#see-5]

* [Ticker#add](#add) For adding handlers
* [Ticker#addOnce](#addonce) For one-time handlers

***

### start() [#start]

\> **start**(): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:413

Starts the ticker. If the ticker has listeners a new animation frame is requested at this point.

#### Returns [#returns-10]

`void`

#### Example [#example-16]

```ts
// Basic manual start
const ticker = new Ticker();
ticker.add(() => {
    // Animation code here
});
ticker.start();
```

#### See [#see-6]

* [Ticker#stop](#stop) For stopping the ticker
* [Ticker#autoStart](#autostart) For automatic starting
* [Ticker#started](#started) For checking ticker state

***

### stop() [#stop]

\> **stop**(): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:426

Stops the ticker. If the ticker has requested an animation frame it is canceled at this point.

#### Returns [#returns-11]

`void`

#### Example [#example-17]

```ts
// Basic stop
const ticker = new Ticker();
ticker.stop();
```

#### See [#see-7]

* [Ticker#start](#start) For starting the ticker
* [Ticker#started](#started) For checking ticker state
* [Ticker#destroy](#destroy) For cleaning up the ticker

***

### update() [#update]

\> **update**(`currentTime?`): `void`

Defined in: node_modules/pixi.js/lib/ticker/Ticker.d.ts:463

Triggers an update.

An update entails setting the
current [elapsedMS](#elapsedms),
the current [deltaTime](#deltatime),
invoking all listeners with current deltaTime,
and then finally setting [lastTime](#lasttime)
with the value of currentTime that was provided.

This method will be called automatically by animation
frame callbacks if the ticker instance has been started
and listeners are added.

#### Parameters [#parameters-5]

##### currentTime? [#currenttime]

`number`

The current time of execution (defaults to performance.now())

#### Returns [#returns-12]

`void`

#### Example [#example-18]

```ts
// Basic manual update
const ticker = new Ticker();
ticker.update(performance.now());
```

#### See [#see-8]

* [Ticker#deltaTime](#deltatime) For frame delta value
* [Ticker#elapsedMS](#elapsedms) For raw elapsed time


# Interface: TickersSequence (/pixi-vn/index/interfaces/TickersSequence)



Defined in: [src/tickers/interfaces/TickersSequence.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersSequence.ts#L26)

The steps of the tickers

## Properties [#properties]

### currentStepNumber [#currentstepnumber]

\> **currentStepNumber**: `number`

Defined in: [src/tickers/interfaces/TickersSequence.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersSequence.ts#L30)

The step number

***

### steps [#steps]

\> **steps**: `TickersStep`\<`any`>\[]

Defined in: [src/tickers/interfaces/TickersSequence.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickersSequence.ts#L34)

The steps of the tickers


# Interface: TvInOutProps (/pixi-vn/index/interfaces/TvInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:273](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L273)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### brightness? [#brightness]

\> `optional` **brightness?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:283](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L283)

How bright the collapsed line glows (`1` = no change).

#### Default [#default-1]

```ts
3
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### lineThickness? [#linethickness]

\> `optional` **lineThickness?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:278](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L278)

The height of the collapsed bright line, as a fraction of the component's own height.

#### Default [#default-4]

```ts
0.02
```

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### scanlines? [#scanlines]

\> `optional` **scanlines?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:288](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L288)

Whether CRT scanlines/noise are shown during the transition.

#### Default [#default-6]

```ts
true
```

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: TwistInOutProps (/pixi-vn/index/interfaces/TwistInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:204](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L204)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
TwistInOutProps, [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps), [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:209](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L209)

How far (degrees) the swirl is wound up - where `twistIn` starts and `twistOut` ends.

#### Default [#default-1]

```ts
540
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `Partial`\<`PointData`>

Defined in: [src/canvas/interfaces/transition-props.ts:219](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L219)

The center of the swirl, normalized to the component's own bounds (`0` to `1` on each axis).

#### Default [#default-5]

```ts
{ x: 0.5, y: 0.5 }
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### radius? [#radius]

\> `optional` **radius?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:214](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L214)

The radius (pixels) of the swirl. Defaults to half the component's diagonal, so the whole
component swirls.

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-6]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: UnresolvedAsset<T> (/pixi-vn/index/interfaces/UnresolvedAsset)



Defined in: node_modules/pixi.js/lib/assets/types.d.ts:216

An asset that has not been resolved yet. This is the initial format used when adding assets
to the Assets system before they are processed into a [ResolvedAsset](/pixi-vn/index/interfaces/ResolvedAsset).

## Example [#example]

```ts
// Basic unresolved asset
const asset: UnresolvedAsset = {
    alias: 'hero',
    src: 'hero.png'
};

// Multiple aliases and formats
const asset: UnresolvedAsset = {
    alias: ['hero', 'player'],
    src: 'hero.{webp,png}',
    data: {
        scaleMode: 'nearest',
    }
};

// Asset with multiple sources and formats
const asset: UnresolvedAsset = {
    alias: 'background',
    src: [
        'bg@2x.webp',
        'bg@1x.webp',
        'bg@2x.png',
        'bg@1x.png',
    ]
};

// With specific loader
const asset: UnresolvedAsset = {
    alias: 'config',
    src: 'data.txt',
    parser: 'text'
};
```

## Remarks [#remarks]

* Used as input format when adding assets to the system
* Can specify multiple aliases for the same asset
* Supports format patterns for browser compatibility
* Can include loader-specific data and options

## See [#see]

* [ResolvedAsset](/pixi-vn/index/interfaces/ResolvedAsset) For the resolved asset format
* Assets.add For adding unresolved assets

## Standard [#standard]

## Type Parameters [#type-parameters]

### T [#t]

`T` = `any`

## Indexable [#indexable]

\> \[`key`: `string`]: `any`

## Properties [#properties]

### alias? [#alias]

\> `optional` **alias?**: `ArrayOr`\<`string`>

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:218

Aliases associated with asset

***

### data? [#data]

\> `optional` **data?**: `T`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:65

Optional data passed to the asset loader.
Can include texture settings, parser options, or other asset-specific data.

***

### format? [#format]

\> `optional` **format?**: `string`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:67

File format of the asset, usually the file extension. Used to determine which loader parser to use.

***

### ~~loadParser?~~ [#loadparser]

\> `optional` **loadParser?**: [`LoadParserName`](/pixi-vn/index/type-aliases/LoadParserName)

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:71

#### Deprecated [#deprecated]

Use `parser` instead.

***

### parser? [#parser]

\> `optional` **parser?**: `AssetParser`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:73

Override to specify which parser should load this asset. Useful when file extensions don't match the content type.

***

### src? [#src]

\> `optional` **src?**: [`AssetSrc`](/pixi-vn/index/type-aliases/AssetSrc)

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:220

The URL or relative path to the asset


# Interface: VideoSpriteMemory (/pixi-vn/index/interfaces/VideoSpriteMemory)



Defined in: [src/canvas/interfaces/memory/VideoSpriteMemory.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/VideoSpriteMemory.ts#L6)

The memory of the video. It uses for save the state of the video.

## Extends [#extends]

* [`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessible`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessibleChildren`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessibleHint`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessibleText`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessibleTitle`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`accessibleType`](/pixi-vn/index/interfaces/ImageSpriteMemory#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`align`](/pixi-vn/index/interfaces/ImageSpriteMemory#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`alpha`](/pixi-vn/index/interfaces/ImageSpriteMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`anchor`](/pixi-vn/index/interfaces/ImageSpriteMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`angle`](/pixi-vn/index/interfaces/ImageSpriteMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/ImageSpriteMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageSpriteMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageSpriteMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ImageSpriteMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`children`](/pixi-vn/index/interfaces/ImageSpriteMemory#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`cullable`](/pixi-vn/index/interfaces/ImageSpriteMemory#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`cullableChildren`](/pixi-vn/index/interfaces/ImageSpriteMemory#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`cullArea`](/pixi-vn/index/interfaces/ImageSpriteMemory#cullarea)

***

### currentTime [#currenttime]

\> **currentTime**: `number`

Defined in: [src/canvas/interfaces/memory/VideoSpriteMemory.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/VideoSpriteMemory.ts#L9)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`cursor`](/pixi-vn/index/interfaces/ImageSpriteMemory#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`eventMode`](/pixi-vn/index/interfaces/ImageSpriteMemory#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`filters`](/pixi-vn/index/interfaces/ImageSpriteMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`height`](/pixi-vn/index/interfaces/ImageSpriteMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`hitArea`](/pixi-vn/index/interfaces/ImageSpriteMemory#hitarea)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L11)

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`index`](/pixi-vn/index/interfaces/ImageSpriteMemory#index)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`interactive`](/pixi-vn/index/interfaces/ImageSpriteMemory#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`interactiveChildren`](/pixi-vn/index/interfaces/ImageSpriteMemory#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageSpriteMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`label`](/pixi-vn/index/interfaces/ImageSpriteMemory#label)

***

### loadIsStarted [#loadisstarted]

\> **loadIsStarted**: `boolean`

Defined in: [src/canvas/interfaces/memory/ImageSpriteMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/ImageSpriteMemory.ts#L7)

#### Inherited from [#inherited-from-29]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`loadIsStarted`](/pixi-vn/index/interfaces/ImageSpriteMemory#loadisstarted)

***

### loop [#loop]

\> **loop**: `boolean`

Defined in: [src/canvas/interfaces/memory/VideoSpriteMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/VideoSpriteMemory.ts#L7)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`mask`](/pixi-vn/index/interfaces/ImageSpriteMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-30]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onclick`](/pixi-vn/index/interfaces/ImageSpriteMemory#onclick)

***

### onEvents? [#onevents]

> `optional` **onEvents?**: [`OnEventsHandlers`](/pixi-vn/index/interfaces/OnEventsHandlers)

Defined in: [src/canvas/components/ListenerExtension.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/ListenerExtension.ts#L6)

#### Inherited from [#inherited-from-31]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onEvents`](/pixi-vn/index/interfaces/ImageSpriteMemory#onevents)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onglobalmousemove`](/pixi-vn/index/interfaces/ImageSpriteMemory#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-33]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onglobalpointermove`](/pixi-vn/index/interfaces/ImageSpriteMemory#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-34]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onglobaltouchmove`](/pixi-vn/index/interfaces/ImageSpriteMemory#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmousedown`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseenter`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseleave`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmousemove`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseout`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseover`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseup`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onmouseupoutside`](/pixi-vn/index/interfaces/ImageSpriteMemory#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointercancel`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerdown`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerenter`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerleave`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointermove`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerout`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerover`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointertap`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerup`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onpointerupoutside`](/pixi-vn/index/interfaces/ImageSpriteMemory#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-53]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onRender`](/pixi-vn/index/interfaces/ImageSpriteMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onrightclick`](/pixi-vn/index/interfaces/ImageSpriteMemory#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onrightdown`](/pixi-vn/index/interfaces/ImageSpriteMemory#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onrightup`](/pixi-vn/index/interfaces/ImageSpriteMemory#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onrightupoutside`](/pixi-vn/index/interfaces/ImageSpriteMemory#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontap`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontouchcancel`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontouchend`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontouchendoutside`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontouchmove`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`ontouchstart`](/pixi-vn/index/interfaces/ImageSpriteMemory#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-64]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`onwheel`](/pixi-vn/index/interfaces/ImageSpriteMemory#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-65]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`origin`](/pixi-vn/index/interfaces/ImageSpriteMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-66]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`parent`](/pixi-vn/index/interfaces/ImageSpriteMemory#parent)

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L15)

The label of the parent container, if it has one

#### Inherited from [#inherited-from-67]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`parentLabel`](/pixi-vn/index/interfaces/ImageSpriteMemory#parentlabel)

***

### paused [#paused]

> **paused**: `boolean`

Defined in: [src/canvas/interfaces/memory/VideoSpriteMemory.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/VideoSpriteMemory.ts#L8)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`percentagePosition`](/pixi-vn/index/interfaces/ImageSpriteMemory#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`percentageX`](/pixi-vn/index/interfaces/ImageSpriteMemory#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-70]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`percentageY`](/pixi-vn/index/interfaces/ImageSpriteMemory#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-71]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`pivot`](/pixi-vn/index/interfaces/ImageSpriteMemory#pivot)

***

### pixivnFilters? [#pixivnfilters]

> `optional` **pixivnFilters?**: `FilterMemory`\[]

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L25)

The filters applied to this element, if any - kept separate from the real, live `Filter[]`
`.filters` (inherited from the PixiJS options types this memory interface also extends) since a
memory object is serialized data, not construction options. Only filters registered with
filterDecorator/RegisteredFilters can be saved - any other `Filter` instance found
on `.filters` is skipped (with a warning) when exporting.

#### Inherited from [#inherited-from-72]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`pixivnFilters`](/pixi-vn/index/interfaces/ImageSpriteMemory#pixivnfilters)

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: [src/canvas/interfaces/memory/CanvasBaseItemMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/CanvasBaseItemMemory.ts#L7)

#### Inherited from [#inherited-from-73]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`pixivnId`](/pixi-vn/index/interfaces/ImageSpriteMemory#pixivnid)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-74]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`position`](/pixi-vn/index/interfaces/ImageSpriteMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-75]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`renderable`](/pixi-vn/index/interfaces/ImageSpriteMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-76]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`rotation`](/pixi-vn/index/interfaces/ImageSpriteMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-77]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`roundPixels`](/pixi-vn/index/interfaces/ImageSpriteMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-78]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`scale`](/pixi-vn/index/interfaces/ImageSpriteMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-79]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`setMask`](/pixi-vn/index/interfaces/ImageSpriteMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-80]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`skew`](/pixi-vn/index/interfaces/ImageSpriteMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-81]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ImageSpriteMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-82]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`sortDirty`](/pixi-vn/index/interfaces/ImageSpriteMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-83]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`tabIndex`](/pixi-vn/index/interfaces/ImageSpriteMemory#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-84]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`texture`](/pixi-vn/index/interfaces/ImageSpriteMemory#texture)

***

### textureData? [#texturedata]

> `optional` **textureData?**: [`AssetMemory`](/pixi-vn/index/interfaces/AssetMemory)

Defined in: [src/canvas/interfaces/memory/SpriteMemory.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/memory/SpriteMemory.ts#L12)

#### Inherited from [#inherited-from-85]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`textureData`](/pixi-vn/index/interfaces/ImageSpriteMemory#texturedata)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-86]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`tint`](/pixi-vn/index/interfaces/ImageSpriteMemory#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-87]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`visible`](/pixi-vn/index/interfaces/ImageSpriteMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-88]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`width`](/pixi-vn/index/interfaces/ImageSpriteMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-89]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`x`](/pixi-vn/index/interfaces/ImageSpriteMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-90]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`xAlign`](/pixi-vn/index/interfaces/ImageSpriteMemory#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-91]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`y`](/pixi-vn/index/interfaces/ImageSpriteMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-92]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`yAlign`](/pixi-vn/index/interfaces/ImageSpriteMemory#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-93]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`zIndex`](/pixi-vn/index/interfaces/ImageSpriteMemory#zindex)


# Interface: VideoSpriteOptions (/pixi-vn/index/interfaces/VideoSpriteOptions)



Defined in: [src/canvas/interfaces/canvas-options.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L23)

## Extends [#extends]

* [`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessible`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessibleChildren`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessibleHint`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessiblePointerEvents`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessibleText`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessibleTitle`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`accessibleType`](/pixi-vn/index/interfaces/ImageSpriteOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L13)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`align`](/pixi-vn/index/interfaces/ImageSpriteOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For toggling visibility
* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`alpha`](/pixi-vn/index/interfaces/ImageContainerMemory#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`anchor`](/pixi-vn/index/interfaces/ImageSpriteMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`angle`](/pixi-vn/index/interfaces/ImageContainerMemory#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`autoGarbageCollect`](/pixi-vn/index/interfaces/ImageSpriteMemory#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#tint](/pixi-vn/index/classes/VideoSprite#tint) For color adjustments

#### Inherited from [#inherited-from-12]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`blendMode`](/pixi-vn/index/interfaces/ImageContainerMemory#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`boundsArea`](/pixi-vn/index/interfaces/ImageContainerMemory#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`cacheAsTexture`](/pixi-vn/index/interfaces/ContainerMemory#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding children
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing children

#### Inherited from [#inherited-from-15]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`children`](/pixi-vn/index/interfaces/ImageSpriteOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`cullable`](/pixi-vn/index/interfaces/ImageSpriteOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`cullableChildren`](/pixi-vn/index/interfaces/ImageSpriteOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`cullArea`](/pixi-vn/index/interfaces/ImageSpriteOptions#cullarea)

***

### currentTime? [#currenttime]

\> `optional` **currentTime?**: `number`

Defined in: [src/canvas/interfaces/canvas-options.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L26)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`cursor`](/pixi-vn/index/classes/VideoSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`eventMode`](/pixi-vn/index/classes/VideoSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`filters`](/pixi-vn/index/interfaces/ContainerMemory#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`height`](/pixi-vn/index/interfaces/ContainerMemory#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`hitArea`](/pixi-vn/index/classes/VideoSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn/index/classes/VideoSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-24]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactive`](/pixi-vn/index/classes/VideoSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-25]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`interactiveChildren`](/pixi-vn/index/classes/VideoSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-26]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`isRenderGroup`](/pixi-vn/index/interfaces/ImageContainerMemory#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`label`](/pixi-vn/index/interfaces/ContainerMemory#label)

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: [src/canvas/interfaces/canvas-options.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L24)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`mask`](/pixi-vn/index/interfaces/ContainerMemory#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onclick`](/pixi-vn/index/classes/VideoSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalmousemove`](/pixi-vn/index/classes/VideoSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobalpointermove`](/pixi-vn/index/classes/VideoSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onglobaltouchmove`](/pixi-vn/index/classes/VideoSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousedown`](/pixi-vn/index/classes/VideoSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseenter`](/pixi-vn/index/classes/VideoSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseleave`](/pixi-vn/index/classes/VideoSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmousemove`](/pixi-vn/index/classes/VideoSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseout`](/pixi-vn/index/classes/VideoSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseover`](/pixi-vn/index/classes/VideoSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseup`](/pixi-vn/index/classes/VideoSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onmouseupoutside`](/pixi-vn/index/classes/VideoSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointercancel`](/pixi-vn/index/classes/VideoSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerdown`](/pixi-vn/index/classes/VideoSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerenter`](/pixi-vn/index/classes/VideoSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerleave`](/pixi-vn/index/classes/VideoSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointermove`](/pixi-vn/index/classes/VideoSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerout`](/pixi-vn/index/classes/VideoSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerover`](/pixi-vn/index/classes/VideoSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointertap`](/pixi-vn/index/classes/VideoSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerup`](/pixi-vn/index/classes/VideoSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onpointerupoutside`](/pixi-vn/index/classes/VideoSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`onRender`](/pixi-vn/index/interfaces/ContainerMemory#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightclick`](/pixi-vn/index/classes/VideoSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightdown`](/pixi-vn/index/classes/VideoSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightup`](/pixi-vn/index/classes/VideoSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onrightupoutside`](/pixi-vn/index/classes/VideoSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontap`](/pixi-vn/index/classes/VideoSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchcancel`](/pixi-vn/index/classes/VideoSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchend`](/pixi-vn/index/classes/VideoSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchendoutside`](/pixi-vn/index/classes/VideoSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchmove`](/pixi-vn/index/classes/VideoSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`ontouchstart`](/pixi-vn/index/classes/VideoSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`VideoSprite`](/pixi-vn/index/classes/VideoSprite).[`onwheel`](/pixi-vn/index/classes/VideoSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`origin`](/pixi-vn/index/interfaces/ImageContainerMemory#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* [Container#addChild](/pixi-vn/index/classes/Container#addchild) For adding to a parent
* [Container#removeChild](/pixi-vn/index/classes/Container#removechild) For removing from parent

#### Inherited from [#inherited-from-63]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`parent`](/pixi-vn/index/interfaces/ImageContainerMemory#parent)

***

### paused? [#paused]

> `optional` **paused?**: `boolean`

Defined in: [src/canvas/interfaces/canvas-options.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/canvas-options.ts#L25)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L43)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`percentagePosition`](/pixi-vn/index/interfaces/ImageSpriteOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L53)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`percentageX`](/pixi-vn/index/interfaces/ImageSpriteOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L63)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`percentageY`](/pixi-vn/index/interfaces/ImageSpriteOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`pivot`](/pixi-vn/index/interfaces/ImageContainerMemory#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`position`](/pixi-vn/index/interfaces/ImageContainerMemory#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For skipping transform updates
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-69]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`renderable`](/pixi-vn/index/interfaces/ImageContainerMemory#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-70]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`rotation`](/pixi-vn/index/interfaces/ImageContainerMemory#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-71]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`roundPixels`](/pixi-vn/index/interfaces/ImageSpriteMemory#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-72]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`scale`](/pixi-vn/index/interfaces/ImageContainerMemory#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-73]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`setMask`](/pixi-vn/index/interfaces/ContainerMemory#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-74]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`skew`](/pixi-vn/index/interfaces/ImageContainerMemory#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-75]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortableChildren`](/pixi-vn/index/interfaces/ContainerMemory#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-76]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`sortDirty`](/pixi-vn/index/interfaces/ContainerMemory#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-77]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`tabIndex`](/pixi-vn/index/interfaces/ImageSpriteOptions#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-78]

[`ImageSpriteMemory`](/pixi-vn/index/interfaces/ImageSpriteMemory).[`texture`](/pixi-vn/index/interfaces/ImageSpriteMemory#texture)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency
* [Container#visible](/pixi-vn/index/classes/VideoSprite#visible) For visibility control

#### Inherited from [#inherited-from-79]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`tint`](/pixi-vn/index/interfaces/ImageSpriteOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* [Container#renderable](/pixi-vn/index/classes/VideoSprite#renderable) For render-only control
* [Container#alpha](/pixi-vn/index/classes/VideoSprite#alpha) For transparency

#### Inherited from [#inherited-from-80]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`visible`](/pixi-vn/index/interfaces/ImageContainerMemory#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-81]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`width`](/pixi-vn/index/interfaces/ContainerMemory#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-82]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`x`](/pixi-vn/index/interfaces/ImageContainerMemory#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L23)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-83]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`xAlign`](/pixi-vn/index/interfaces/ImageSpriteOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-84]

[`ImageContainerMemory`](/pixi-vn/index/interfaces/ImageContainerMemory).[`y`](/pixi-vn/index/interfaces/ImageContainerMemory#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: [src/canvas/components/AdditionalPositionsExtension.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/AdditionalPositionsExtension.ts#L33)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`ImageSpriteOptions`](/pixi-vn/index/interfaces/ImageSpriteOptions).[`yAlign`](/pixi-vn/index/interfaces/ImageSpriteOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn/index/classes/VideoSprite#sortablechildren) For enabling sorting
* [Container#sortChildren](/pixi-vn/index/classes/Container#sortchildren) For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-86]

[`ContainerMemory`](/pixi-vn/index/interfaces/ContainerMemory).[`zIndex`](/pixi-vn/index/interfaces/ContainerMemory#zindex)


# Interface: VignettePulseEffectProps (/pixi-vn/index/interfaces/VignettePulseEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:299](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L299)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), [WiggleEffectProps](/pixi-vn/index/interfaces/WiggleEffectProps), [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### blur? [#blur]

\> `optional` **blur?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:320](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L320)

How soft the transition from the clear center to the dark edges is (`0` = a hard edge).

#### Default [#default-1]

```ts
0.5
```

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### pulses? [#pulses]

\> `optional` **pulses?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:309](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L309)

The number of pulses.

#### Default [#default-6]

```ts
1
```

***

### radius? [#radius]

\> `optional` **radius?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:315](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L315)

How far the darkening reaches in from the corners, from `0` (none) to `1` (the whole element) -
`0.5` darkens roughly the outer half.

#### Default [#default-7]

```ts
0.5
```

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-8]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:304](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L304)

The peak vignette opacity of the first, largest pulse.

#### Default [#default-9]

```ts
1
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-10]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-11]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: WarpInOutProps (/pixi-vn/index/interfaces/WarpInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:221](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L221)

Shared options for the filter-based reveal/conceal transitions ([GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps),
[TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps), WarpInOutProps, [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps),
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps), [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps)).

## Extends [#extends]

* [`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`FilterFadeTransitionProps.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounce`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`damping`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`driver`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`duration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`ease`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#elapsed)

***

### fadeComponent? [#fadecomponent]

\> `optional` **fadeComponent?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:179](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L179)

Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
(same behavior as [BlurInOutProps.fadeComponent](/pixi-vn/index/interfaces/BlurInOutProps#fadecomponent)). The default depends on the transition.

#### Inherited from [#inherited-from-13]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`fadeComponent`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#fadecomponent)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`from`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`inherit`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`isSync`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`mass`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`max`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`min`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#modifytarget)

***

### origin? [#origin]

\> `optional` **origin?**: `Partial`\<`PointData`>

Defined in: [src/canvas/interfaces/transition-props.ts:231](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L231)

The point the streaks radiate from, normalized to the component's own bounds.

#### Default [#default-4]

```ts
{ x: 0.5, y: 0.5 }
```

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`path`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`power`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeat`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`startTime`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#stiffness)

***

### strength? [#strength]

\> `optional` **strength?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:226](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L226)

The zoom-blur strength `warpIn` starts from and `warpOut` ends at.

#### Default [#default-6]

```ts
0.6
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`FilterFadeTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`FilterFadeTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`times`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`type`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`velocity`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`FilterFadeTransitionProps`](/pixi-vn/index/interfaces/FilterFadeTransitionProps).[`when`](/pixi-vn/index/interfaces/FilterFadeTransitionProps#when)


# Interface: WiggleEffectProps (/pixi-vn/index/interfaces/WiggleEffectProps)



Defined in: [src/canvas/interfaces/effect-props.ts:88](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L88)

Shared options for the generic, repeated articulated-animation effects ([BounceEffectProps](/pixi-vn/index/interfaces/BounceEffectProps),
[HopEffectProps](/pixi-vn/index/interfaces/HopEffectProps), WiggleEffectProps, [NodEffectProps](/pixi-vn/index/interfaces/NodEffectProps), [SwayEffectProps](/pixi-vn/index/interfaces/SwayEffectProps)):
a number of cycles, each one shrinking towards rest by [decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay).

## Extends [#extends]

* [`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`DecayingEffectProps.aliasToRemoveAfter`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L93)

The peak rotation (in degrees) away from the component's current angle, on the first repetition.

#### Default [#default-1]

```ts
15
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`autoplay`](/pixi-vn/index/interfaces/DecayingEffectProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounce`](/pixi-vn/index/interfaces/DecayingEffectProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceDamping`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`bounceStiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`completeOnContinue`](/pixi-vn/index/interfaces/DecayingEffectProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`damping`](/pixi-vn/index/interfaces/DecayingEffectProps#damping)

***

### decay? [#decay]

\> `optional` **decay?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L35)

How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
amplitude, `0` = the second cycle onward has no amplitude at all).

#### Default [#default-4]

```ts
0.5
```

#### Inherited from [#inherited-from-7]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`decay`](/pixi-vn/index/interfaces/DecayingEffectProps#decay)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-8]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delay`](/pixi-vn/index/interfaces/DecayingEffectProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-9]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`delayChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-10]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`driver`](/pixi-vn/index/interfaces/DecayingEffectProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`duration`](/pixi-vn/index/interfaces/DecayingEffectProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-12]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`ease`](/pixi-vn/index/interfaces/DecayingEffectProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`elapsed`](/pixi-vn/index/interfaces/DecayingEffectProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-14]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`from`](/pixi-vn/index/interfaces/DecayingEffectProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`inherit`](/pixi-vn/index/interfaces/DecayingEffectProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`isSync`](/pixi-vn/index/interfaces/DecayingEffectProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-5]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`mass`](/pixi-vn/index/interfaces/DecayingEffectProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`max`](/pixi-vn/index/interfaces/DecayingEffectProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`min`](/pixi-vn/index/interfaces/DecayingEffectProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`modifyTarget`](/pixi-vn/index/interfaces/DecayingEffectProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`path`](/pixi-vn/index/interfaces/DecayingEffectProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`power`](/pixi-vn/index/interfaces/DecayingEffectProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`reduceMotion`](/pixi-vn/index/interfaces/DecayingEffectProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeat`](/pixi-vn/index/interfaces/DecayingEffectProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatDelay`](/pixi-vn/index/interfaces/DecayingEffectProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`repeatType`](/pixi-vn/index/interfaces/DecayingEffectProps#repeattype)

***

### repetitions? [#repetitions]

\> `optional` **repetitions?**: `number`

Defined in: [src/canvas/interfaces/effect-props.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/effect-props.ts#L98)

The number of repetitions.

#### Default [#default-6]

```ts
3
```

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restDelta`](/pixi-vn/index/interfaces/DecayingEffectProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`restSpeed`](/pixi-vn/index/interfaces/DecayingEffectProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`skipAnimations`](/pixi-vn/index/interfaces/DecayingEffectProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerChildren`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`staggerDirection`](/pixi-vn/index/interfaces/DecayingEffectProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`startTime`](/pixi-vn/index/interfaces/DecayingEffectProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`stiffness`](/pixi-vn/index/interfaces/DecayingEffectProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`DecayingEffectProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`DecayingEffectProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`timeConstant`](/pixi-vn/index/interfaces/DecayingEffectProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`times`](/pixi-vn/index/interfaces/DecayingEffectProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`type`](/pixi-vn/index/interfaces/DecayingEffectProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`velocity`](/pixi-vn/index/interfaces/DecayingEffectProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`visualDuration`](/pixi-vn/index/interfaces/DecayingEffectProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`DecayingEffectProps`](/pixi-vn/index/interfaces/DecayingEffectProps).[`when`](/pixi-vn/index/interfaces/DecayingEffectProps#when)


# Interface: WipeInOutProps (/pixi-vn/index/interfaces/WipeInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:61](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L61)

Shared options for the mask-based reveal/conceal transitions (WipeInOutProps,
[IrisInOutProps](/pixi-vn/index/interfaces/IrisInOutProps), [SplitInOutProps](/pixi-vn/index/interfaces/SplitInOutProps)).

## Extends [#extends]

* [`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`MaskTransitionProps.aliasToRemoveAfter`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: [src/canvas/interfaces/transition-props.ts:68](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L68)

The angle (in degrees) the wipe boundary sweeps towards. `0` is left-to-right, `90` is
bottom-to-top, `180` is right-to-left, `270` is top-to-bottom, and any other value produces a
diagonal wipe.

#### Default [#default-1]

```ts
0
```

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`autoplay`](/pixi-vn/index/interfaces/MaskTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounce`](/pixi-vn/index/interfaces/MaskTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceDamping`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`bounceStiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`completeOnContinue`](/pixi-vn/index/interfaces/MaskTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-3]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`damping`](/pixi-vn/index/interfaces/MaskTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delay`](/pixi-vn/index/interfaces/MaskTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`delayChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/transition-props.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L74)

A convenience shorthand for [angle](#angle): `"right"` (`0`), `"up"` (`90`), `"left"` (`180`),
`"down"` (`270`). Ignored if `angle` is also set.

#### Default [#default-4]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`driver`](/pixi-vn/index/interfaces/MaskTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`duration`](/pixi-vn/index/interfaces/MaskTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`ease`](/pixi-vn/index/interfaces/MaskTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`elapsed`](/pixi-vn/index/interfaces/MaskTransitionProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`from`](/pixi-vn/index/interfaces/MaskTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`inherit`](/pixi-vn/index/interfaces/MaskTransitionProps#inherit)

***

### invert? [#invert]

\> `optional` **invert?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:59](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L59)

If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.

#### Default [#default-5]

```ts
false
```

#### Inherited from [#inherited-from-15]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`invert`](/pixi-vn/index/interfaces/MaskTransitionProps#invert)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-16]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`isSync`](/pixi-vn/index/interfaces/MaskTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-6]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`mass`](/pixi-vn/index/interfaces/MaskTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`max`](/pixi-vn/index/interfaces/MaskTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`min`](/pixi-vn/index/interfaces/MaskTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`modifyTarget`](/pixi-vn/index/interfaces/MaskTransitionProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`path`](/pixi-vn/index/interfaces/MaskTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`power`](/pixi-vn/index/interfaces/MaskTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`reduceMotion`](/pixi-vn/index/interfaces/MaskTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeat`](/pixi-vn/index/interfaces/MaskTransitionProps#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatDelay`](/pixi-vn/index/interfaces/MaskTransitionProps#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`repeatType`](/pixi-vn/index/interfaces/MaskTransitionProps#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restDelta`](/pixi-vn/index/interfaces/MaskTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`restSpeed`](/pixi-vn/index/interfaces/MaskTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`skipAnimations`](/pixi-vn/index/interfaces/MaskTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerChildren`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`staggerDirection`](/pixi-vn/index/interfaces/MaskTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-32]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`startTime`](/pixi-vn/index/interfaces/MaskTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-7]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`stiffness`](/pixi-vn/index/interfaces/MaskTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-8]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`MaskTransitionProps.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-9]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`MaskTransitionProps.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`timeConstant`](/pixi-vn/index/interfaces/MaskTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-37]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`times`](/pixi-vn/index/interfaces/MaskTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`type`](/pixi-vn/index/interfaces/MaskTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-39]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`velocity`](/pixi-vn/index/interfaces/MaskTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`visualDuration`](/pixi-vn/index/interfaces/MaskTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`MaskTransitionProps`](/pixi-vn/index/interfaces/MaskTransitionProps).[`when`](/pixi-vn/index/interfaces/MaskTransitionProps#when)


# Interface: ZoomInOutProps (/pixi-vn/index/interfaces/ZoomInOutProps)



Defined in: [src/canvas/interfaces/transition-props.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L29)

## Extends [#extends]

* `BaseTransitionProps`.`AnimationOptions`

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2239

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2062

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2136

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2128

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/canvas/interfaces/transition-props.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L11)

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2082

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2370

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2178

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: [src/canvas/interfaces/transition-props.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/interfaces/transition-props.ts#L34)

The direction of the zoom effect.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2224

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2238

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2209

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2223

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2241

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2248

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1982

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2148

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2118

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2267

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2105

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1993

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

`AnimationOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2012

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

`AnimationOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2005

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

`AnimationOptions.repeatType`

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2030

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2022

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2256

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2191

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2200

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2073

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2112

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2210

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2232

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2015

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2050

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2169

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Function: calculateAlignByPosition() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculateAlignByPosition)



\> **calculateAlignByPosition**(`type`, `position`, `value`, `pivot`, `negativeScale`, `anchor?`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L42)

## Parameters [#parameters]

### type [#type]

`"width"` | `"height"`

### position [#position]

`number`

### value [#value]

`number`

### pivot [#pivot]

`number`

### negativeScale [#negativescale]

`boolean`

### anchor? [#anchor]

`number` = `0`

## Returns [#returns]

`number`


# Function: calculatePercentagePositionByPosition() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePercentagePositionByPosition)



\> **calculatePercentagePositionByPosition**(`type`, `position`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:88](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L88)

## Parameters [#parameters]

### type [#type]

`"width"` | `"height"`

### position [#position]

`number`

## Returns [#returns]

`number`


# Function: calculatePositionByAlign() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePositionByAlign)



\> **calculatePositionByAlign**(`type`, `align`, `value`, `pivot`, `negativeScale`, `anchor?`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L5)

## Parameters [#parameters]

### type [#type]

`"width"` | `"height"`

### align [#align]

`number`

### value [#value]

`number`

### pivot [#pivot]

`number`

### negativeScale [#negativescale]

`boolean`

### anchor? [#anchor]

`number` = `0`

## Returns [#returns]

`number`


# Function: calculatePositionByPercentagePosition() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePositionByPercentagePosition)



\> **calculatePositionByPercentagePosition**(`type`, `percentage`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:77](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L77)

## Parameters [#parameters]

### type [#type]

`"width"` | `"height"`

### percentage [#percentage]

`number`

## Returns [#returns]

`number`


# Function: getPointBySuperPoint() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getPointBySuperPoint)



\> **getPointBySuperPoint**(`superPoint`, `angle`): `object`

Defined in: [src/canvas/functions/canvas-property-utility.ts:175](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L175)

## Parameters [#parameters]

### superPoint [#superpoint]

#### x [#x]

`number`

#### y [#y]

`number`

### angle [#angle]

`number`

## Returns [#returns]

`object`

### x [#x-1]

\> **x**: `number`

### y [#y-1]

\> **y**: `number`


# Function: getSuperHeight() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperHeight)



\> **getSuperHeight**(`canvasElement`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:246](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L246)

## Parameters [#parameters]

### canvasElement [#canvaselement]

`Container`

## Returns [#returns]

`number`


# Function: getSuperPoint() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperPoint)



\> **getSuperPoint**(`point`, `angle`): `object`

Defined in: [src/canvas/functions/canvas-property-utility.ts:99](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L99)

## Parameters [#parameters]

### point [#point]

#### x [#x]

`number`

#### y [#y]

`number`

### angle [#angle]

`number`

## Returns [#returns]

`object`

### x [#x-1]

\> **x**: `number`

### y [#y-1]

\> **y**: `number`


# Function: getSuperWidth() (/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperWidth)



\> **getSuperWidth**(`canvasElement`): `number`

Defined in: [src/canvas/functions/canvas-property-utility.ts:227](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-property-utility.ts#L227)

## Parameters [#parameters]

### canvasElement [#canvaselement]

`Container`

## Returns [#returns]

`number`


# CanvasPropertyUtility (/pixi-vn/index/namespaces/CanvasPropertyUtility)



## Functions [#functions]

* [calculateAlignByPosition](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculateAlignByPosition)
* [calculatePercentagePositionByPosition](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePercentagePositionByPosition)
* [calculatePositionByAlign](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePositionByAlign)
* [calculatePositionByPercentagePosition](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/calculatePositionByPercentagePosition)
* [getPointBySuperPoint](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getPointBySuperPoint)
* [getSuperHeight](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperHeight)
* [getSuperPoint](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperPoint)
* [getSuperWidth](/pixi-vn/index/namespaces/CanvasPropertyUtility/functions/getSuperWidth)


# Function: addOnError() (/pixi-vn/index/namespaces/Game/functions/addOnError)



\> **addOnError**(`value`): () => `void`

Defined in: [src/index.ts:359](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L359)

Register an error handler. Multiple handlers can be registered; they
will be executed in registration order.

You can also check if the error is an instance of [PixiError](/pixi-vn/index/classes/PixiError) to handle specific errors related to Pixi’VN.

## Parameters [#parameters]

### value [#value]

[`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)

## Returns [#returns]

() => `void`

## Example [#example]

```ts
// Register a synchronous error handler
Game.addOnError((error, props) => {
   props.notify("An error occurred")
   // send a notification to GlitchTip, Sentry, etc...
})

// Register an error handler for Pixi’VN specific errors
Game.addOnError((error, { notify }) => {
    if (error instanceof PixiError) {
        // ...
    }
});

// Register an asynchronous error handler
Game.addOnError(async (error, props) => {
   await logErrorToServer(error)
   props.notify("An error occurred")
})

// Register an error handler with step restoration/rollback
Game.addOnError(async (error, props) => {
   // Restore the game state to the previous step
   await stepHistory.back(props)
   props.notify("An error occurred, returning to previous step")
})
```


# Function: addOnPreContinue() (/pixi-vn/index/namespaces/Game/functions/addOnPreContinue)



\> **addOnPreContinue**(`handler`): `void`

Defined in: [src/index.ts:491](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L491)

Register a handler to run immediately before a narration "continue" operation.
Handlers are executed in registration order and may be async. Use
`{@link addOnPreContinue}` / `{@link removeOnPreContinue}` to manage them programmatically.

## Parameters [#parameters]

### handler [#handler]

() => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`


# Function: clear() (/pixi-vn/index/namespaces/Game/functions/clear)



\> **clear**(): `void`

Defined in: [src/index.ts:238](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L238)

Clear all game data. This function is used to reset the game.

## Returns [#returns]

`void`


# Function: exportGameState() (/pixi-vn/index/namespaces/Game/functions/exportGameState)



\> **exportGameState**(): `Promise`\<[`GameState`](/pixi-vn/index/interfaces/GameState)>

Defined in: [src/index.ts:252](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L252)

Get all the game data. It can be used to save the game.

## Returns [#returns]

`Promise`\<[`GameState`](/pixi-vn/index/interfaces/GameState)>

The game data


# Function: init() (/pixi-vn/index/namespaces/Game/functions/init)



## Call Signature [#call-signature]

\> **init**(`element`, `options`, `devtoolsOptions?`): `Promise`\<`void`>

Defined in: [src/index.ts:89](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L89)

Initialize the Game and PixiJS Application and the interface div.
This method should be called before any other method.

### Parameters [#parameters]

#### element [#element]

`HTMLElement`

The html element where I will put the canvas. Example: document.body

#### options [#options]

`Partial`\<[`ApplicationOptions`](/pixi-vn/index/interfaces/ApplicationOptions)> & `object`

Equivalent to the options you can use when initializing a [PixiJS Application](https://pixijs.com/8.x/guides/components/application). Additionally, it supports the following options:

* `id`: The id of the canvas element.
* `navigate`: The route navigate function.
* `resizeMode`: The resize mode of the canvas.

#### devtoolsOptions? [#devtoolsoptions]

`Devtools`

Equivalent to the options you can use when initializing the [PixiJS Devtools](https://pixi-vn.com/start/canvas#use-pixijs-devtools-with-pixivn).

### Returns [#returns]

`Promise`\<`void`>

### Example [#example]

```ts
const body = document.body
if (!body) {
    throw new Error('body element not found')
}
await Game.initialize(body, {
    navigate: (path) => {
        // navigate to the path
    },
    width: 1920,
    height: 1080,
    backgroundColor: "#303030"
    resizeMode: "contain"
})
```

## Call Signature [#call-signature-1]

\> **init**(): `Promise`\<`void`>

Defined in: [src/index.ts:119](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L119)

Initialize only the GameUnifier, and not the PixiJS Application and the interface div.
This method can be used if you want to use only the GameUnifier features, such as save/load game,
without initializing the canvas.

### Returns [#returns-1]

`Promise`\<`void`>


# Function: jsonToGameState() (/pixi-vn/index/namespaces/Game/functions/jsonToGameState)



\> **jsonToGameState**(`json`): [`GameState`](/pixi-vn/index/interfaces/GameState)

Defined in: [src/index.ts:307](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L307)

Convert a JSON string to a save data

## Parameters [#parameters]

### json [#json]

`string`

The JSON string

## Returns [#returns]

[`GameState`](/pixi-vn/index/interfaces/GameState)

The save data


# Function: onEnd() (/pixi-vn/index/namespaces/Game/functions/onEnd)



\> **onEnd**(`value`): `void`

Defined in: [src/index.ts:320](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L320)

Function to be executed at the end of the game. It should be set in the game initialization.

## Parameters [#parameters]

### value [#value]

[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)

## Returns [#returns]

`void`

## Example [#example]

```ts
Game.onEnd(async (props) => {
   props.navigate("/end")
})
```


# Function: onLabelClosing() (/pixi-vn/index/namespaces/Game/functions/onLabelClosing)



\> **onLabelClosing**(`value`): `void`

Defined in: [src/index.ts:462](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L462)

Is a function that will be executed every time the current label is about to close because it
naturally ran out of steps and control is returning to the label that called it.

By default (when this is not set), the label closes immediately, exactly like before this hook
existed. If you set it, you take control: call `defaultClose()` yourself whenever you actually
want the label to close — right away, or later (e.g. on a subsequent player action in your
template). Until `defaultClose()` is called, the label stays open and narration does not
continue into the parent label.

This does not fire for a `jump` or a choice's `closeCurrentLabel` option - those close the
current label as part of starting a new one, so [onLabelStarting](/pixi-vn/index/namespaces/Game/functions/onLabelStarting) already covers
deferring them.

## Parameters [#parameters]

### value [#value]

(`labelId`, `props`, `defaultClose`) => [`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

## Returns [#returns]

`void`

## Example [#example]

```ts
Game.onLabelClosing((labelId, props, defaultClose) => {
    pendingLabelClose = defaultClose; // keep it for later, don't run it now
})
```


# Function: onLabelStarting() (/pixi-vn/index/namespaces/Game/functions/onLabelStarting)



\> **onLabelStarting**(`value`): `void`

Defined in: [src/index.ts:428](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L428)

Is a function that will be executed every time a label is about to be started, either via
`narration.call`, `narration.jump`, or a choice of type `"call"` / `"jump"`.

By default (when this is not set), the label starts immediately, exactly like before this hook
existed. If you set it, you take control: call `defaultStart()` yourself whenever you actually
want the label to run — right away, or later (e.g. on a subsequent player action in your
template). Until `defaultStart()` is called, nothing about the label happens: it is not added to
the history and no step of it runs.

## Parameters [#parameters]

### value [#value]

(`labelId`, `props`, `options`, `defaultStart`) => [`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

## Returns [#returns]

`void`

## Example [#example]

```ts
Game.onLabelStarting((labelId, props, options, defaultStart) => {
    pendingLabelStart = defaultStart; // keep it for later, don't run it now
})
```


# Function: onLoadingLabel() (/pixi-vn/index/namespaces/Game/functions/onLoadingLabel)



\> **onLoadingLabel**(`value`): `void`

Defined in: [src/index.ts:396](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L396)

Is a function that will be executed in [onStepStart](/pixi-vn/index/namespaces/Game/functions/onStepStart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the [narrationUtils.narration](/pixi-vn/index/variables/narration).openedLabels.
It is useful for example to make sure all images used have been cached

## Parameters [#parameters]

### value [#value]

(`stepId`, `label`) => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`

## Example [#example]

```ts
Game.onLoadingLabel(async (stepId, label) => {
    await Assets.load('path/to/image1.png')
    await Assets.load('path/to/image2.png')
})
```


# Function: onNavigate() (/pixi-vn/index/namespaces/Game/functions/onNavigate)



\> **onNavigate**(`value`): `void`

Defined in: [src/index.ts:482](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L482)

Function to be executed when navigation is requested.

## Parameters [#parameters]

### value [#value]

(`path`) => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`

## Example [#example]

```ts
Game.onNavigate(async (path) => {
   // custom navigation logic
   window.history.pushState({}, "title", path)
})
```


# Function: onStepEnd() (/pixi-vn/index/namespaces/Game/functions/onStepEnd)



\> **onStepEnd**(`value`): `void`

Defined in: [src/index.ts:407](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L407)

Is a function that will be executed when the step ends.

## Parameters [#parameters]

### value [#value]

(`stepId`, `label`) => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`


# Function: onStepStart() (/pixi-vn/index/namespaces/Game/functions/onStepStart)



\> **onStepStart**(`value`): `void`

Defined in: [src/index.ts:375](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L375)

Is a function that will be executed before any step is executed.

## Parameters [#parameters]

### value [#value]

(`stepId`, `label`) => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`


# Function: removeOnError() (/pixi-vn/index/namespaces/Game/functions/removeOnError)



\> **removeOnError**(`handler`): `void`

Defined in: [src/index.ts:366](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L366)

Remove a previously registered error handler.

## Parameters [#parameters]

### handler [#handler]

[`OnErrorHandler`](/pixi-vn/index/type-aliases/OnErrorHandler)

## Returns [#returns]

`void`


# Function: removeOnPreContinue() (/pixi-vn/index/namespaces/Game/functions/removeOnPreContinue)



\> **removeOnPreContinue**(`handler`): `void`

Defined in: [src/index.ts:494](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L494)

## Parameters [#parameters]

### handler [#handler]

() => `void` | `Promise`\<`void`>

## Returns [#returns]

`void`


# Function: restoreGameState() (/pixi-vn/index/namespaces/Game/functions/restoreGameState)



\> **restoreGameState**(`data`): `Promise`\<`void`>

Defined in: [src/index.ts:271](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L271)

Load the save data

## Parameters [#parameters]

### data [#data]

[`GameState`](/pixi-vn/index/interfaces/GameState)

The save data object to restore the game state from.

## Returns [#returns]

`Promise`\<`void`>


# Function: start() (/pixi-vn/index/namespaces/Game/functions/start)



\> **start**\<`T`>(`label`, `props`): `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/index.ts:294](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L294)

Start the game with a label. This function will clear all the game data and start the narration from the specified label.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }

## Parameters [#parameters]

### label [#label]

`string` | [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `T`, `number`>

The label to start the game with. It can be a string or a LabelAbstract instance. If it is a string, it will be used as the id of the label to start. If it is a LabelAbstract instance, it will be used directly. If the label is not found, an error will be thrown.

### props [#props]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

The properties to pass to the label. It will be passed to the [StepLabelType](/pixi-vn/index/type-aliases/StepLabelType) of the label when it is executed.

## Returns [#returns]

`Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

The result of the label execution. It can be a [StepLabelResultType](/pixi-vn/index/type-aliases/StepLabelResultType) or a Promise that resolves to a [StepLabelResultType](/pixi-vn/index/type-aliases/StepLabelResultType).


# Game (/pixi-vn/index/namespaces/Game)



## Variables [#variables]

* [testing](/pixi-vn/index/namespaces/Game/variables/testing)
* [worker](/pixi-vn/index/namespaces/Game/variables/worker)

## Functions [#functions]

* [addOnError](/pixi-vn/index/namespaces/Game/functions/addOnError)
* [addOnPreContinue](/pixi-vn/index/namespaces/Game/functions/addOnPreContinue)
* [clear](/pixi-vn/index/namespaces/Game/functions/clear)
* [exportGameState](/pixi-vn/index/namespaces/Game/functions/exportGameState)
* [init](/pixi-vn/index/namespaces/Game/functions/init)
* [jsonToGameState](/pixi-vn/index/namespaces/Game/functions/jsonToGameState)
* [onEnd](/pixi-vn/index/namespaces/Game/functions/onEnd)
* [onLabelClosing](/pixi-vn/index/namespaces/Game/functions/onLabelClosing)
* [onLabelStarting](/pixi-vn/index/namespaces/Game/functions/onLabelStarting)
* [onLoadingLabel](/pixi-vn/index/namespaces/Game/functions/onLoadingLabel)
* [onNavigate](/pixi-vn/index/namespaces/Game/functions/onNavigate)
* [onStepEnd](/pixi-vn/index/namespaces/Game/functions/onStepEnd)
* [onStepStart](/pixi-vn/index/namespaces/Game/functions/onStepStart)
* [removeOnError](/pixi-vn/index/namespaces/Game/functions/removeOnError)
* [removeOnPreContinue](/pixi-vn/index/namespaces/Game/functions/removeOnPreContinue)
* [restoreGameState](/pixi-vn/index/namespaces/Game/functions/restoreGameState)
* [start](/pixi-vn/index/namespaces/Game/functions/start)


# Variable: testing (/pixi-vn/index/namespaces/Game/variables/testing)



\> `const` **testing**: `object`

Defined in: [src/index.ts:555](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L555)

Lets an AI agent (or any external script/browser console) drive and inspect a running game
through `window`, without needing to know the app's own UI wiring. Not enabled by default —
something must opt in, typically only in development. Two pieces are needed:

* `enable()`/`disable()` turn the `window` bridge on/off — the `@drincs/pixi-vn/vite` plugin's
  `testing` option does this automatically while its dev server is running, with no extra code.
* `setProps(props)` keeps the live app props (`navigate`/`t`/`toast`/etc.) available to every
  action — call it unconditionally from wherever your app builds those props (e.g. at the end
  of a `useGameProps()`-style hook), since every action needs up-to-date props whether or not
  testing happens to be enabled right now.
* `setActions(actions)` is optional: if the app wraps `narration`/`stepHistory` in its own
  functions to handle UI-only concerns (a loading indicator, blocking while a menu is open,
  refreshing cached interface data, ...), it can register those functions so `continue()`,
  `goBack()`, `selectChoice()`, `start()`, `jump()` and `call()` drive the game through them
  instead of calling `narration`/`stepHistory` directly — same as a real player action would.
  See the `pixi-vn-testing` skill for the full guide (activation patterns, the complete command
  surface, and cookbook snippets for a browser-driven test session).

## Type Declaration [#type-declaration]

### disable [#disable]

\> **disable**: () => `void`

Disables a session started with `enable`: removes the error handler and, if it's
still the current value, deletes `window[windowKey]`. No-op if testing isn't enabled.

#### Returns [#returns]

`void`

### enable [#enable]

\> **enable**: \<`T`>(`options?`) => [`GameTestingAPI`](/pixi-vn/index/interfaces/GameTestingAPI)\<*typeof* [`Game`](/pixi-vn/index/namespaces/Game), `T`>

Enables the testing API: builds it, attaches it to `window[windowKey]` (default
`"pixiVN"`), and returns it. Calling this again replaces the previous session.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `object` = \{ }

#### Parameters [#parameters]

##### options? [#options]

###### windowKey? [#windowkey]

`string`

The property name to attach the API under on `window`.

#### Returns [#returns-1]

[`GameTestingAPI`](/pixi-vn/index/interfaces/GameTestingAPI)\<*typeof* [`Game`](/pixi-vn/index/namespaces/Game), `T`>

#### Default [#default]

```ts
"pixiVN"
```

### isEnabled [#isenabled]

\> **isEnabled**: () => `boolean`

Whether a testing session is currently active.

#### Returns [#returns-2]

`boolean`

### setActions [#setactions]

\> **setActions**: \<`T`>(`actions`) => `void`

Registers the app's own narration functions so [GameTestingAPI](/pixi-vn/index/interfaces/GameTestingAPI)'s `continue`,
`goBack`, `selectChoice`, `start`, `jump` and `call` call them instead of going straight to
`narration`/`stepHistory` — useful when the app wraps those with UI-only concerns (e.g. a
loading indicator, blocking while a menu is open, refreshing cached interface data) that a
test session driving the game through `window` should also go through, exactly like a real
player action would. Safe to call whether or not testing is currently `enable`d, and
safe to call again to update the registered functions (e.g. when they close over fresh
props). Persists across `disable`/`enable`, same as `setProps`.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `object` = \{ }

#### Parameters [#parameters-1]

##### actions [#actions]

[`GameTestingActions`](/pixi-vn/index/interfaces/GameTestingActions)\<`T`>

The app's own narration functions to use in place of the defaults. Pass `{}`
(or omit an action) to keep/restore the default behavior for that action.

#### Returns [#returns-3]

`void`

### setProps [#setprops]

\> **setProps**: \<`T`>(`props`) => `void`

Updates the live props every [GameTestingAPI](/pixi-vn/index/interfaces/GameTestingAPI) action merges `extraProps` on top of.
Call this unconditionally from wherever your app builds its `StepLabelProps` (e.g. the end
of a `useGameProps()`-style hook that already runs throughout the app) — it's a cheap
assignment, safe to call whether or not testing is currently `enable`d.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `object` = \{ }

#### Parameters [#parameters-2]

##### props [#props]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

The app's current `StepLabelProps` (the same object your UI passes to
`narration.continue`/`Game.start`).

#### Returns [#returns-4]

`void`


# Variable: worker (/pixi-vn/index/namespaces/Game/variables/worker)



\> `const` **worker**: `object`

Defined in: [src/index.ts:529](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L529)

Optional integration point for offloading Pixi'VN's own heavy, pure computations (state
diffing/restoring/cloning for `stepHistory.back()`/`add()`/`export()`) to a Worker the game
project provides. Pixi'VN never creates a Worker itself, decides on its own which eligible
work actually goes through it, and falls back to computing the same thing synchronously
on the main thread whenever none is registered - so projects that can't or don't want to
use Workers (SSR, certain embeds, ...) are unaffected either way.

The game project stays in control of the actual `new Worker(...)` call (bundler-specific
URL/`type: "module"` handling, CSP, lifecycle) and only needs to point that worker's
message handling at `handleGameWorkerMessage` from `@drincs/pixi-vn/worker`:

```ts
// main thread
import { Game } from "@drincs/pixi-vn";
const worker = new Worker(new URL("./game-worker.ts", import.meta.url), { type: "module" });
Game.worker.register(worker);

// game-worker.ts
import { handleGameWorkerMessage } from "@drincs/pixi-vn/worker";
self.onmessage = async (event) => {
    const response = await handleGameWorkerMessage(event.data);
    if (response) self.postMessage(response);
};
```

A third-party library built on top of Pixi'VN (one with `@drincs/pixi-vn` as a peer
dependency) can share this same worker for its own heavy, pure computations instead of
needing one of its own - see `registerGameWorkerHandler` (worker side) and
`GameWorkerManager.custom` (main-thread side), both from `@drincs/pixi-vn/worker`.

## Type Declaration [#type-declaration]

### register [#register]

\> **register**: (`worker`) => `void`

#### Parameters [#parameters]

##### worker [#worker]

`Worker`

#### Returns [#returns]

`void`

### unregister [#unregister]

\> **unregister**: () => `void`

#### Returns [#returns-1]

`void`

### isAvailable [#isavailable]

#### Get Signature [#get-signature]

\> **get** **isAvailable**(): `boolean`

##### Returns [#returns-2]

`boolean`


# Function: add() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/add)



\> **add**\<`M`, `T`>(`target`, `options?`): `void`

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:171](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L171)

Register a canvas component in the game.

## Type Parameters [#type-parameters]

### M [#m]

`M` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

### T [#t]

`T` *extends* *typeof* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)

## Parameters [#parameters]

### target [#target]

`T`

The class of the canvas component.

### options? [#options]

Options for the canvas component.

#### copyProperty? [#copyproperty]

(`component`, `memory`) => `void` | `Promise`\<`void`>

Function to copy the properties of the canvas component. This function is used when to copy the properties of the canvas component into another instance of the same canvas component.
This function is used into [canvas.copyCanvasElementProperty](/pixi-vn/index/interfaces/CanvasManagerInterface#copycanvaselementproperty) to copy the properties of the canvas component.

#### getInstance? [#getinstance]

(`canvasClass`, `memory`) => [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`> | `Promise`\<[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`>>

Function to get the instance of the canvas component. If not set, it will use the default constructor of the class.
This function is used into [canvas.restore](/pixi-vn/index/interfaces/CanvasManagerInterface#restore) to restore the canvas.

#### name? [#name]

`string`

Name of the canvas component. If the name is already registered, it will show a warning

**Default**

```ts
target.name
```

## Returns [#returns]

`void`


# Function: copyProperty() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/copyProperty)



\> **copyProperty**\<`M`>(`canvasId`, `component`, `source`): `Promise`\<`void`>

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:258](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L258)

## Type Parameters [#type-parameters]

### M [#m]

`M` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

## Parameters [#parameters]

### canvasId [#canvasid]

`string`

### component [#component]

[`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`>

### source [#source]

[`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

## Returns [#returns]

`Promise`\<`void`>


# Function: get() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/get)



\> **get**\<`T`>(`canvasId`): `T` | `undefined`

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:225](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L225)

Get a canvas component by the id.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* *typeof* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)

## Parameters [#parameters]

### canvasId [#canvasid]

`string`

The id of the canvas component.

## Returns [#returns]

`T` | `undefined`

The canvas component type.


# Function: getInstance() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/getInstance)



\> **getInstance**\<`M`, `T`>(`canvasId`, `memory`): `Promise`\<`T` | `undefined`>

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:238](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L238)

## Type Parameters [#type-parameters]

### M [#m]

`M` *extends* [`CanvasBaseItemMemory`](/pixi-vn/index/interfaces/CanvasBaseItemMemory)

### T [#t]

`T` *extends* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`M`>

## Parameters [#parameters]

### canvasId [#canvasid]

`string`

### memory [#memory]

`M`

## Returns [#returns]

`Promise`\<`T` | `undefined`>


# Function: has() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:291](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L291)

Check if a canvas component is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the canvas component.

## Returns [#returns]

`boolean`

True if the canvas component is registered, false otherwise.


# Function: keys() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/keys)



\> **keys**(): `string`\[]

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:299](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L299)

Get a list of all canvas component ids registered.

## Returns [#returns]

`string`\[]

An array of label ids.


# Function: values() (/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/values)



\> **values**(): *typeof* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\[]

Defined in: [src/canvas/decorators/canvas-element-decorator.ts:282](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/canvas-element-decorator.ts#L282)

Get a list of all canvas components registered.

## Returns [#returns]

*typeof* [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\[]

An array of canvas components.


# RegisteredCanvasComponents (/pixi-vn/index/namespaces/RegisteredCanvasComponents)



## Functions [#functions]

* [add](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/add)
* [copyProperty](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/copyProperty)
* [get](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/get)
* [getInstance](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/getInstance)
* [has](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/has)
* [keys](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/keys)
* [values](/pixi-vn/index/namespaces/RegisteredCanvasComponents/functions/values)


# Function: add() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/add)



\> **add**(...`characters`): `void`

Defined in: [src/characters/decorators/RegisteredCharacters.ts:51](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L51)

Is a function that saves the character. If the character already exists, it will be overwritten.

## Parameters [#parameters]

### characters [#characters]

...(`CharacterInterface` | `CharacterInterface`\[])\[]

is the character(s) to save

## Returns [#returns]

`void`

## Example [#example]

```ts
export const liam = new CharacterBaseModel('liam', { name: 'Liam'});
export const alice = new CharacterBaseModel('alice', { name: 'Alice'});
RegisteredCharacters.add(liam, alice);
RegisteredCharacters.add([liam, alice]);
```


# Function: clear() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/clear)



\> **clear**(): `void`

Defined in: [src/characters/decorators/RegisteredCharacters.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L98)

Removes all registered characters.

## Returns [#returns]

`void`


# Function: get() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/get)



\> **get**\<`T`, `T2`>(`id`): `T` | `undefined`

Defined in: [src/characters/decorators/RegisteredCharacters.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L20)

is a function that returns the character by the id

## Type Parameters [#type-parameters]

### T [#t]

`T` = `CharacterInterface`

### T2 [#t2]

`T2` *extends* `string` = `string`

## Parameters [#parameters]

### id [#id]

`T2`

is the id of the character

## Returns [#returns]

`T` | `undefined`

the character

## Example [#example]

```ts
const liam = RegisteredCharacters.get('liam');
```


# Function: has() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/characters/decorators/RegisteredCharacters.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L83)

Check if a character is registered.

## Parameters [#parameters]

### id [#id]

`string`

is the id of the character

## Returns [#returns]

`boolean`

true if the character exists, false otherwise


# Function: keys() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/keys)



\> **keys**(): `string`\[]

Defined in: [src/characters/decorators/RegisteredCharacters.ts:91](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L91)

Get a list of all character ids registered.

## Returns [#returns]

`string`\[]

An array of character ids.


# Function: values() (/pixi-vn/index/namespaces/RegisteredCharacters/functions/values)



\> **values**\<`T`>(): `T`\[]

Defined in: [src/characters/decorators/RegisteredCharacters.ts:74](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/decorators/RegisteredCharacters.ts#L74)

is a function that returns all characters

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `CharacterInterface`

## Returns [#returns]

`T`\[]

all characters

## Example [#example]

```ts
const allCharacters = RegisteredCharacters.values();
```


# RegisteredCharacters (/pixi-vn/index/namespaces/RegisteredCharacters)



## Functions [#functions]

* [add](/pixi-vn/index/namespaces/RegisteredCharacters/functions/add)
* [clear](/pixi-vn/index/namespaces/RegisteredCharacters/functions/clear)
* [get](/pixi-vn/index/namespaces/RegisteredCharacters/functions/get)
* [has](/pixi-vn/index/namespaces/RegisteredCharacters/functions/has)
* [keys](/pixi-vn/index/namespaces/RegisteredCharacters/functions/keys)
* [values](/pixi-vn/index/namespaces/RegisteredCharacters/functions/values)


# Function: add() (/pixi-vn/index/namespaces/RegisteredEvents/functions/add)



\> **add**(`fn`, `name`): `void`

Defined in: [src/canvas/decorators/event-decorator.ts:43](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L43)

Register a event in the game.

## Parameters [#parameters]

### fn [#fn]

`SerializableEventHandler`

The class of the event.

### name [#name]

`string`

Name of the event, by default it will use the class name. If the name is already registered, it will show a warning

## Returns [#returns]

`void`


# Function: get() (/pixi-vn/index/namespaces/RegisteredEvents/functions/get)



\> **get**(`name`): `SerializableEventHandler` | `undefined`

Defined in: [src/canvas/decorators/event-decorator.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L56)

Get a event by the id.

## Parameters [#parameters]

### name [#name]

`string`

## Returns [#returns]

`SerializableEventHandler` | `undefined`

The event type.


# Function: has() (/pixi-vn/index/namespaces/RegisteredEvents/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/canvas/decorators/event-decorator.ts:85](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L85)

Check if a event is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the event.

## Returns [#returns]

`boolean`

True if the event is registered, false otherwise


# Function: keys() (/pixi-vn/index/namespaces/RegisteredEvents/functions/keys)



\> **keys**(): `string`\[]

Defined in: [src/canvas/decorators/event-decorator.ts:93](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L93)

Get a list of all event ids registered.

## Returns [#returns]

`string`\[]

An array of label ids.


# Function: values() (/pixi-vn/index/namespaces/RegisteredEvents/functions/values)



\> **values**(): `SerializableEventHandler`\[]

Defined in: [src/canvas/decorators/event-decorator.ts:76](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/decorators/event-decorator.ts#L76)

Get a list of all events registered.

## Returns [#returns]

`SerializableEventHandler`\[]

An array of events.


# RegisteredEvents (/pixi-vn/index/namespaces/RegisteredEvents)



## Functions [#functions]

* [add](/pixi-vn/index/namespaces/RegisteredEvents/functions/add)
* [get](/pixi-vn/index/namespaces/RegisteredEvents/functions/get)
* [has](/pixi-vn/index/namespaces/RegisteredEvents/functions/has)
* [keys](/pixi-vn/index/namespaces/RegisteredEvents/functions/keys)
* [values](/pixi-vn/index/namespaces/RegisteredEvents/functions/values)


# Function: add() (/pixi-vn/index/namespaces/RegisteredLabels/functions/add)



\> **add**(...`labels`): `void`

Defined in: [src/narration/decorators/RegisteredLabels.ts:36](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L36)

Saves a label in the system

## Parameters [#parameters]

### labels [#labels]

...[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, `any`, `number`>\[]

The label(s) to be saved

## Returns [#returns]

`void`


# Function: clear() (/pixi-vn/index/namespaces/RegisteredLabels/functions/clear)



\> **clear**(): `void`

Defined in: [src/narration/decorators/RegisteredLabels.ts:70](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L70)

Removes all registered labels.

## Returns [#returns]

`void`


# Function: get() (/pixi-vn/index/namespaces/RegisteredLabels/functions/get)



\> **get**\<`T`, `T2`>(`id`): `T` | `undefined`

Defined in: [src/narration/decorators/RegisteredLabels.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L21)

Gets a label by its id

## Type Parameters [#type-parameters]

### T [#t]

`T` = [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`>

### T2 [#t2]

`T2` *extends* `string` = `string`

## Parameters [#parameters]

### id [#id]

`T2`

The id of the label

## Returns [#returns]

`T` | `undefined`

The label or undefined if it does not exist


# Function: has() (/pixi-vn/index/namespaces/RegisteredLabels/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/narration/decorators/RegisteredLabels.ts:55](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L55)

Check if a label is registered

## Parameters [#parameters]

### id [#id]

`string`

The id of the label

## Returns [#returns]

`boolean`

True if the label is registered, false otherwise


# Function: keys() (/pixi-vn/index/namespaces/RegisteredLabels/functions/keys)



\> **keys**(): `string`\[]

Defined in: [src/narration/decorators/RegisteredLabels.ts:63](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L63)

Get a list of all label ids registered.

## Returns [#returns]

`string`\[]

An array of label ids.


# Function: values() (/pixi-vn/index/namespaces/RegisteredLabels/functions/values)



\> **values**(): [`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`>\[]

Defined in: [src/narration/decorators/RegisteredLabels.ts:46](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/decorators/RegisteredLabels.ts#L46)

Get a list of all labels registered.

## Returns [#returns]

[`LabelAbstract`](/pixi-vn/index/classes/LabelAbstract)\<`any`, \{ }, `number`>\[]

An array of labels.


# RegisteredLabels (/pixi-vn/index/namespaces/RegisteredLabels)



## Functions [#functions]

* [add](/pixi-vn/index/namespaces/RegisteredLabels/functions/add)
* [clear](/pixi-vn/index/namespaces/RegisteredLabels/functions/clear)
* [get](/pixi-vn/index/namespaces/RegisteredLabels/functions/get)
* [has](/pixi-vn/index/namespaces/RegisteredLabels/functions/has)
* [keys](/pixi-vn/index/namespaces/RegisteredLabels/functions/keys)
* [values](/pixi-vn/index/namespaces/RegisteredLabels/functions/values)


# Function: add() (/pixi-vn/index/namespaces/RegisteredTickers/functions/add)



\> **add**(`target`, `name?`): `void`

Defined in: [src/tickers/decorators/RegisteredTickers.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L54)

Register a ticker in the game.

## Parameters [#parameters]

### target [#target]

(`args`, `options?`) => [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>

The class of the ticker.

### name? [#name]

`string`

Name of the ticker, by default it will use the class name. If the name is already registered, it will show a warning

## Returns [#returns]

`void`


# Function: get() (/pixi-vn/index/namespaces/RegisteredTickers/functions/get)



\> **get**\<`T`>(`tickerId`): `T` | `undefined`

Defined in: [src/tickers/decorators/RegisteredTickers.ts:83](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L83)

Get a ticker by the id.

## Type Parameters [#type-parameters]

### T [#t]

`T` = [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>

## Parameters [#parameters]

### tickerId [#tickerid]

`string`

## Returns [#returns]

`T` | `undefined`

The ticker type.


# Function: getInstance() (/pixi-vn/index/namespaces/RegisteredTickers/functions/getInstance)



\> **getInstance**\<`TArgs`>(`tickerId`, `args`, `options?`): [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

Defined in: [src/tickers/decorators/RegisteredTickers.ts:107](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L107)

Get a ticker instance by the id.

## Type Parameters [#type-parameters]

### TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/pixi-vn/index/interfaces/TickerArgs)

## Parameters [#parameters]

### tickerId [#tickerid]

`string`

The id of the ticker.

### args [#args]

`TArgs`

The arguments that you want to pass to the ticker.

### options? [#options]

#### canvasElementAliases? [#canvaselementaliases]

`string`\[]

#### duration? [#duration]

`number`

#### id? [#id]

`string`

#### priority? [#priority]

`UPDATE_PRIORITY`

## Returns [#returns]

[`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`TArgs`> | `undefined`

The instance of the ticker


# Function: has() (/pixi-vn/index/namespaces/RegisteredTickers/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/tickers/decorators/RegisteredTickers.ts:155](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L155)

Check if a ticker is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the ticker.

## Returns [#returns]

`boolean`

True if the ticker is registered, false otherwise.


# Function: keys() (/pixi-vn/index/namespaces/RegisteredTickers/functions/keys)



\> **keys**(): `string`\[]

Defined in: [src/tickers/decorators/RegisteredTickers.ts:163](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L163)

Get a list of all ticker ids registered.

## Returns [#returns]

`string`\[]

An array of label ids.


# Function: values() (/pixi-vn/index/namespaces/RegisteredTickers/functions/values)



\> **values**(): (`args`, `options?`) => [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>\[]

Defined in: [src/tickers/decorators/RegisteredTickers.ts:136](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/decorators/RegisteredTickers.ts#L136)

Get a list of all tickers registered.

## Returns [#returns]

(`args`, `options?`) => [`Ticker`](/pixi-vn/index/interfaces/Ticker)\<`any`>\[]

An array of tickers.


# RegisteredTickers (/pixi-vn/index/namespaces/RegisteredTickers)



## Functions [#functions]

* [add](/pixi-vn/index/namespaces/RegisteredTickers/functions/add)
* [get](/pixi-vn/index/namespaces/RegisteredTickers/functions/get)
* [getInstance](/pixi-vn/index/namespaces/RegisteredTickers/functions/getInstance)
* [has](/pixi-vn/index/namespaces/RegisteredTickers/functions/has)
* [keys](/pixi-vn/index/namespaces/RegisteredTickers/functions/keys)
* [values](/pixi-vn/index/namespaces/RegisteredTickers/functions/values)


# SoundRegistry (/pixi-vn/index/namespaces/SoundRegistry)



SoundRegistry is a singleton namespace that holds global state for the sound system.
**DO NOT** import this module directly; use `sound`.

## Variables [#variables]

* [bufferRegistry](/pixi-vn/index/namespaces/SoundRegistry/variables/bufferRegistry)
* [channels](/pixi-vn/index/namespaces/SoundRegistry/variables/channels)
* [mediaInstances](/pixi-vn/index/namespaces/SoundRegistry/variables/mediaInstances)
* [systemPausedAliases](/pixi-vn/index/namespaces/SoundRegistry/variables/systemPausedAliases)
* [transients](/pixi-vn/index/namespaces/SoundRegistry/variables/transients)


# Variable: bufferRegistry (/pixi-vn/index/namespaces/SoundRegistry/variables/bufferRegistry)



\> `const` **bufferRegistry**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`string`, `ToneAudioBuffer`>

Defined in: [src/sound/SoundRegistry.ts:20](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/SoundRegistry.ts#L20)


# Variable: channels (/pixi-vn/index/namespaces/SoundRegistry/variables/channels)



\> `const` **channels**: `Map`\<`string`, [`AudioChannelInterface`](/pixi-vn/index/interfaces/AudioChannelInterface)>

Defined in: [src/sound/SoundRegistry.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/SoundRegistry.ts#L12)


# Variable: mediaInstances (/pixi-vn/index/namespaces/SoundRegistry/variables/mediaInstances)



\> `const` **mediaInstances**: `Map`\<`string`, `MediaInstance`>

Defined in: [src/sound/SoundRegistry.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/SoundRegistry.ts#L11)


# Variable: systemPausedAliases (/pixi-vn/index/namespaces/SoundRegistry/variables/systemPausedAliases)



\> `const` **systemPausedAliases**: `Set`\<`string`>

Defined in: [src/sound/SoundRegistry.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/SoundRegistry.ts#L19)

Aliases of [mediaInstances](/pixi-vn/index/namespaces/SoundRegistry/variables/mediaInstances) that were paused by `unsaved.pauseAll`.
Used by `unsaved.resumeAll` to only resume the instances it paused, leaving
any previously-paused instances untouched.


# Variable: transients (/pixi-vn/index/namespaces/SoundRegistry/variables/transients)



\> `const` **transients**: `Set`\<`Player`>

Defined in: [src/sound/SoundRegistry.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/SoundRegistry.ts#L13)


# Function: clearOldTempVariables() (/pixi-vn/index/namespaces/StorageRegistry/functions/clearOldTempVariables)



\> **clearOldTempVariables**(`openedLabelsNumber`): `void`

Defined in: [src/storage/StorageRegistry.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L17)

## Parameters [#parameters]

### openedLabelsNumber [#openedlabelsnumber]

`number`

## Returns [#returns]

`void`


# Function: getFlag() (/pixi-vn/index/namespaces/StorageRegistry/functions/getFlag)



\> **getFlag**(`key`): `boolean`

Defined in: [src/storage/StorageRegistry.ts:68](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L68)

## Parameters [#parameters]

### key [#key]

`string`

## Returns [#returns]

`boolean`


# Function: getVariable() (/pixi-vn/index/namespaces/StorageRegistry/functions/getVariable)



\> **getVariable**\<`T`>(`prefix`, `key`): `T` | `undefined`

Defined in: [src/storage/StorageRegistry.ts:40](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L40)

## Type Parameters [#type-parameters]

### T [#t]

`T` = [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

## Parameters [#parameters]

### prefix [#prefix]

`string`

### key [#key]

`string`

## Returns [#returns]

`T` | `undefined`


# Function: removeVariable() (/pixi-vn/index/namespaces/StorageRegistry/functions/removeVariable)



\> **removeVariable**(`prefix`, `key`): `void`

Defined in: [src/storage/StorageRegistry.ts:48](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L48)

## Parameters [#parameters]

### prefix [#prefix]

`string`

### key [#key]

`string`

## Returns [#returns]

`void`


# Function: setExternalStoreHandler() (/pixi-vn/index/namespaces/StorageRegistry/functions/setExternalStoreHandler)



\> **setExternalStoreHandler**(`handler?`): `void`

Defined in: [src/storage/StorageRegistry.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L27)

## Parameters [#parameters]

### handler? [#handler]

[`StorageExternalStoreHandler`](/pixi-vn/index/interfaces/StorageExternalStoreHandler)

## Returns [#returns]

`void`


# Function: setFlag() (/pixi-vn/index/namespaces/StorageRegistry/functions/setFlag)



\> **setFlag**(`key`, `value`): `void`

Defined in: [src/storage/StorageRegistry.ts:53](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L53)

## Parameters [#parameters]

### key [#key]

`string`

### value [#value]

`boolean`

## Returns [#returns]

`void`


# Function: setVariable() (/pixi-vn/index/namespaces/StorageRegistry/functions/setVariable)



\> **setVariable**(`prefix`, `key`, `value`): `void`

Defined in: [src/storage/StorageRegistry.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L31)

## Parameters [#parameters]

### prefix [#prefix]

`string`

### key [#key]

`string`

### value [#value]

[`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)

## Returns [#returns]

`void`


# StorageRegistry (/pixi-vn/index/namespaces/StorageRegistry)



StorageRegistry  is a singleton namespace that holds global state for the storage system.
**DO NOT** import this module directly; use `storage`.

## Variables [#variables]

* [defaultStorage](/pixi-vn/index/namespaces/StorageRegistry/variables/defaultStorage)
* [storage](/pixi-vn/index/namespaces/StorageRegistry/variables/storage)
* [tempStorageDeadlines](/pixi-vn/index/namespaces/StorageRegistry/variables/tempStorageDeadlines)

## Functions [#functions]

* [clearOldTempVariables](/pixi-vn/index/namespaces/StorageRegistry/functions/clearOldTempVariables)
* [getFlag](/pixi-vn/index/namespaces/StorageRegistry/functions/getFlag)
* [getVariable](/pixi-vn/index/namespaces/StorageRegistry/functions/getVariable)
* [removeVariable](/pixi-vn/index/namespaces/StorageRegistry/functions/removeVariable)
* [setExternalStoreHandler](/pixi-vn/index/namespaces/StorageRegistry/functions/setExternalStoreHandler)
* [setFlag](/pixi-vn/index/namespaces/StorageRegistry/functions/setFlag)
* [setVariable](/pixi-vn/index/namespaces/StorageRegistry/functions/setVariable)


# Variable: defaultStorage (/pixi-vn/index/namespaces/StorageRegistry/variables/defaultStorage)



\> `const` **defaultStorage**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`string`, `any`>

Defined in: [src/storage/StorageRegistry.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L13)


# Variable: storage (/pixi-vn/index/namespaces/StorageRegistry/variables/storage)



\> `const` **storage**: [`CachedMap`](/pixi-vn/index/classes/CachedMap)\<`string`, `any`>

Defined in: [src/storage/StorageRegistry.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L12)


# Variable: tempStorageDeadlines (/pixi-vn/index/namespaces/StorageRegistry/variables/tempStorageDeadlines)



\> `const` **tempStorageDeadlines**: `Map`\<`string`, `number`>

Defined in: [src/storage/StorageRegistry.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/StorageRegistry.ts#L14)


# Function: addTickerTimeoutInfo() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/addTickerTimeoutInfo)



\> **addTickerTimeoutInfo**(`aliases`, `ticker`, `timeout`, `canBeDeletedBeforeEnd`): `void`

Defined in: [src/tickers/TickersManagerStatic.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L56)

## Parameters [#parameters]

### aliases [#aliases]

`string` | `string`\[]

### ticker [#ticker]

`string`

### timeout [#timeout]

`string`

### canBeDeletedBeforeEnd [#canbedeletedbeforeend]

`boolean`

## Returns [#returns]

`void`


# Function: currentTickersSequence() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/currentTickersSequence)



\> **currentTickersSequence**(): `object`

Defined in: [src/tickers/TickersManagerStatic.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L34)

## Returns [#returns]

`object`


# Function: currentTickersWithoutCreatedBySteps() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/currentTickersWithoutCreatedBySteps)



\> **currentTickersWithoutCreatedBySteps**(): `object`

Defined in: [src/tickers/TickersManagerStatic.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L13)

## Returns [#returns]

`object`


# Function: generateTickerId() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/generateTickerId)



\> **generateTickerId**(...`args`): `string`

Defined in: [src/tickers/TickersManagerStatic.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L49)

## Parameters [#parameters]

### args [#args]

...`any`\[]

## Returns [#returns]

`string`


# Function: removeTickerTimeout() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeout)



\> **removeTickerTimeout**(`timeout`): `void`

Defined in: [src/tickers/TickersManagerStatic.ts:77](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L77)

## Parameters [#parameters]

### timeout [#timeout]

`string` | `Timeout`

## Returns [#returns]

`void`


# Function: removeTickerTimeoutInfo() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeoutInfo)



\> **removeTickerTimeoutInfo**(`timeout`): `void`

Defined in: [src/tickers/TickersManagerStatic.ts:71](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L71)

## Parameters [#parameters]

### timeout [#timeout]

`string` | `Timeout`

## Returns [#returns]

`void`


# Function: removeTickerTimeoutsByAlias() (/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeoutsByAlias)



\> **removeTickerTimeoutsByAlias**(`alias`, `checkCanBeDeletedBeforeEnd`): `void`

Defined in: [src/tickers/TickersManagerStatic.ts:84](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L84)

## Parameters [#parameters]

### alias [#alias]

`string`

### checkCanBeDeletedBeforeEnd [#checkcanbedeletedbeforeend]

`boolean`

## Returns [#returns]

`void`


# TickersManagerStatic (/pixi-vn/index/namespaces/TickersManagerStatic)



Static, module-scoped ticker bookkeeping - moved out of `CanvasManagerStatic` (formerly
`CanvasManagerStatic`'s "Edit Tickers Methods" section) so the `tickers` module can own its own
state without importing `@drincs/pixi-vn/canvas`.

## Variables [#variables]

* [\_currentTickers](/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickers)
* [\_currentTickersSequence](/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickersSequence)
* [\_currentTickersTimeouts](/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickersTimeouts)
* [\_tickersToCompleteOnStepEnd](/pixi-vn/index/namespaces/TickersManagerStatic/variables/tickersToCompleteOnStepEnd)

## Functions [#functions]

* [addTickerTimeoutInfo](/pixi-vn/index/namespaces/TickersManagerStatic/functions/addTickerTimeoutInfo)
* [currentTickersSequence](/pixi-vn/index/namespaces/TickersManagerStatic/functions/currentTickersSequence)
* [currentTickersWithoutCreatedBySteps](/pixi-vn/index/namespaces/TickersManagerStatic/functions/currentTickersWithoutCreatedBySteps)
* [generateTickerId](/pixi-vn/index/namespaces/TickersManagerStatic/functions/generateTickerId)
* [removeTickerTimeout](/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeout)
* [removeTickerTimeoutInfo](/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeoutInfo)
* [removeTickerTimeoutsByAlias](/pixi-vn/index/namespaces/TickersManagerStatic/functions/removeTickerTimeoutsByAlias)


# Variable: _currentTickers (/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickers)



\> `const` **\_currentTickers**: `Map`\<`string`, [`TickerInfo`](/pixi-vn/index/interfaces/TickerInfo)\<`any`>>

Defined in: [src/tickers/TickersManagerStatic.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L32)


# Variable: _currentTickersSequence (/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickersSequence)



\> `const` **\_currentTickersSequence**: `Map`\<`string`, `Map`\<`string`, [`TickersSequence`](/pixi-vn/index/interfaces/TickersSequence)>>

Defined in: [src/tickers/TickersManagerStatic.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L33)


# Variable: _currentTickersTimeouts (/pixi-vn/index/namespaces/TickersManagerStatic/variables/currentTickersTimeouts)



\> `const` **\_currentTickersTimeouts**: `Map`\<`string`, [`TickerTimeoutHistory`](/pixi-vn/index/interfaces/TickerTimeoutHistory)>

Defined in: [src/tickers/TickersManagerStatic.ts:44](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L44)


# Variable: _tickersToCompleteOnStepEnd (/pixi-vn/index/namespaces/TickersManagerStatic/variables/tickersToCompleteOnStepEnd)



\> `const` **\_tickersToCompleteOnStepEnd**: `object`

Defined in: [src/tickers/TickersManagerStatic.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/TickersManagerStatic.ts#L45)

## Type Declaration [#type-declaration]

### stepAlias [#stepalias]

\> **stepAlias**: `object`\[]

### tikersIds [#tikersids]

\> **tikersIds**: `object`\[]


# Function: blurPulseEffect() (/pixi-vn/index/namespaces/effects/functions/blurPulseEffect)



\> **blurPulseEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:660](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L660)

Pulse a blur on the canvas element: a repeated, decaying blur bump that settles back to no blur
between and after each pulse ([BlurFilter](https://pixijs.io/filters/docs/BlurFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`BlurPulseEffectProps`](/pixi-vn/index/interfaces/BlurPulseEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: bounceEffect() (/pixi-vn/index/namespaces/effects/functions/bounceEffect)



\> **bounceEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:180](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L180)

Bounce the canvas element: a one-directional displacement that repeatedly returns to rest, each
bounce shrinking towards rest by [BounceEffectProps.decay](/pixi-vn/index/interfaces/DecayingEffectProps#decay). Like a dropped ball settling.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`BounceEffectProps`](/pixi-vn/index/interfaces/BounceEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: chromaticAberrationEffect() (/pixi-vn/index/namespaces/effects/functions/chromaticAberrationEffect)



\> **chromaticAberrationEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:526](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L526)

Chromatic-aberration the canvas element: the red and blue color channels split apart in opposite
directions and snap back, in a decaying burst
([RGBSplitFilter](https://pixijs.io/filters/docs/RGBSplitFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`ChromaticAberrationEffectProps`](/pixi-vn/index/interfaces/ChromaticAberrationEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: desaturateEffect() (/pixi-vn/index/namespaces/effects/functions/desaturateEffect)



\> **desaturateEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:730](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L730)

Desaturate the canvas element: color drains out to [DesaturateEffectProps.amount](/pixi-vn/index/interfaces/DesaturateEffectProps#amount) and
recovers back to normal - a single dip, not a repeated oscillation
([AdjustmentFilter](https://pixijs.io/filters/docs/AdjustmentFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`DesaturateEffectProps`](/pixi-vn/index/interfaces/DesaturateEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: glitchEffect() (/pixi-vn/index/namespaces/effects/functions/glitchEffect)



\> **glitchEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:463](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L463)

Glitch the canvas element: decaying, jittery bursts of digital-corruption slice displacement
([GlitchFilter](https://pixijs.io/filters/docs/GlitchFilter.html)) - each burst snaps,
kicks back the other way and settles - with a matching red/blue channel split layered on top
([RGBSplitFilter](https://pixijs.io/filters/docs/RGBSplitFilter.html), see
[GlitchEffectProps.rgbSplit](/pixi-vn/index/interfaces/GlitchEffectProps#rgbsplit)). Both filters are removed once done. Returns one ticker id
per filter.

Known cosmetic quirk: `GlitchFilter`'s own `destroy()` (called once this effect completes, to
clean up its displacement texture) can log a harmless `PixiJS Warning: [BindGroup] a
'textureSource'/'textureSampler' was destroyed while still bound to a shader` in the console -
this comes from `pixi-filters`' own implementation, not from this effect, doesn't affect the
component's rendering or state, and every property is still correctly restored/detached.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`GlitchEffectProps`](/pixi-vn/index/interfaces/GlitchEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: glowPulseEffect() (/pixi-vn/index/namespaces/effects/functions/glowPulseEffect)



\> **glowPulseEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:766](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L766)

Pulse a glow on the canvas element: a repeated, decaying outward glow that settles back to no
glow between and after each pulse ([GlowFilter](https://pixijs.io/filters/docs/GlowFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`GlowPulseEffectProps`](/pixi-vn/index/interfaces/GlowPulseEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: hopEffect() (/pixi-vn/index/namespaces/effects/functions/hopEffect)



\> **hopEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:255](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L255)

Hop the canvas element: one deliberate displacement-and-return, optionally followed by smaller,
decaying secondary hops.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`HopEffectProps`](/pixi-vn/index/interfaces/HopEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: nodEffect() (/pixi-vn/index/namespaces/effects/functions/nodEffect)



\> **nodEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:322](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L322)

Nod the canvas element: a decaying positional oscillation along one axis.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`NodEffectProps`](/pixi-vn/index/interfaces/NodEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: pulseEffect() (/pixi-vn/index/namespaces/effects/functions/pulseEffect)



\> **pulseEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:219](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L219)

Pulse the canvas element: a repeated, decaying scale bump away from its current scale and back.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`PulseEffectProps`](/pixi-vn/index/interfaces/PulseEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: punchEffect() (/pixi-vn/index/namespaces/effects/functions/punchEffect)



\> **punchEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:401](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L401)

Punch the canvas element: a single fast impulse (position, rotation, or scale) with a strong
attack and a short, slightly overshooting recovery back to rest - unlike every other effect here,
this is a one-shot impact, not a repeated oscillation.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`PunchEffectProps`](/pixi-vn/index/interfaces/PunchEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: radialBlurEffect() (/pixi-vn/index/namespaces/effects/functions/radialBlurEffect)



\> **radialBlurEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:620](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L620)

Radially blur the canvas element: a decaying burst of zoom-blur radiating from an origin point,
settling back to no blur between and after each burst
([ZoomBlurFilter](https://pixijs.io/filters/docs/ZoomBlurFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`RadialBlurEffectProps`](/pixi-vn/index/interfaces/RadialBlurEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: shakeEffect() (/pixi-vn/index/namespaces/effects/functions/shakeEffect)



\> **shakeEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L98)

Shake the canvas element.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`ShakeEffectProps`](/pixi-vn/index/interfaces/ShakeEffectProps) = `{}`

Animation options, matching the `options` of animate function.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker. This parameter sets the ticker's priority.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: shockwaveEffect() (/pixi-vn/index/namespaces/effects/functions/shockwaveEffect)



\> **shockwaveEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:566](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L566)

Shockwave the canvas element: a single radial ripple distortion travels outward from an origin
point and fades ([ShockwaveFilter](https://pixijs.io/filters/docs/ShockwaveFilter.html)) -
a one-shot impact, not a repeated oscillation.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`ShockwaveEffectProps`](/pixi-vn/index/interfaces/ShockwaveEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: swayEffect() (/pixi-vn/index/namespaces/effects/functions/swayEffect)



\> **swayEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:351](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L351)

Sway the canvas element: a smooth, optionally combined positional and rotational drift around its
current state - a gentler, slower cousin of [nodEffect](/pixi-vn/index/namespaces/effects/functions/nodEffect)/[wiggleEffect](/pixi-vn/index/namespaces/effects/functions/wiggleEffect).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`SwayEffectProps`](/pixi-vn/index/interfaces/SwayEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: vignettePulseEffect() (/pixi-vn/index/namespaces/effects/functions/vignettePulseEffect)



\> **vignettePulseEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:693](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L693)

Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying
pulse - built on [CRTFilter](https://pixijs.io/filters/docs/CRTFilter.html) with its
scanline/noise features turned off, isolating just the vignette.

The vignette darkens the corners of the element's own bounding rectangle, so it's meant for
backgrounds and other full-frame images; on a sprite with transparent corners (a character, a
shape) there's little to darken and it barely shows.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`VignettePulseEffectProps`](/pixi-vn/index/interfaces/VignettePulseEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# Function: wiggleEffect() (/pixi-vn/index/namespaces/effects/functions/wiggleEffect)



\> **wiggleEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:294](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L294)

Wiggle the canvas element: a decaying rotation oscillation around its current angle.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`WiggleEffectProps`](/pixi-vn/index/interfaces/WiggleEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>


# effects (/pixi-vn/index/namespaces/effects)



## Functions [#functions]

* [blurPulseEffect](/pixi-vn/index/namespaces/effects/functions/blurPulseEffect)
* [bounceEffect](/pixi-vn/index/namespaces/effects/functions/bounceEffect)
* [chromaticAberrationEffect](/pixi-vn/index/namespaces/effects/functions/chromaticAberrationEffect)
* [desaturateEffect](/pixi-vn/index/namespaces/effects/functions/desaturateEffect)
* [glitchEffect](/pixi-vn/index/namespaces/effects/functions/glitchEffect)
* [glowPulseEffect](/pixi-vn/index/namespaces/effects/functions/glowPulseEffect)
* [hopEffect](/pixi-vn/index/namespaces/effects/functions/hopEffect)
* [nodEffect](/pixi-vn/index/namespaces/effects/functions/nodEffect)
* [pulseEffect](/pixi-vn/index/namespaces/effects/functions/pulseEffect)
* [punchEffect](/pixi-vn/index/namespaces/effects/functions/punchEffect)
* [radialBlurEffect](/pixi-vn/index/namespaces/effects/functions/radialBlurEffect)
* [shakeEffect](/pixi-vn/index/namespaces/effects/functions/shakeEffect)
* [shockwaveEffect](/pixi-vn/index/namespaces/effects/functions/shockwaveEffect)
* [swayEffect](/pixi-vn/index/namespaces/effects/functions/swayEffect)
* [vignettePulseEffect](/pixi-vn/index/namespaces/effects/functions/vignettePulseEffect)
* [wiggleEffect](/pixi-vn/index/namespaces/effects/functions/wiggleEffect)


# Function: blurIn() (/pixi-vn/index/namespaces/transitions/functions/blurIn)



\> **blurIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1730](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1730)

Show a image in the canvas with a blur effect: the image appears already blurred and sharpens
into focus. A generic blur, not a "dream"/"flashback" transition specifically - combine it with
[showWithFade](/pixi-vn/index/namespaces/transitions/functions/showWithFade) for that recipe. See [BlurInOutProps](/pixi-vn/index/interfaces/BlurInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`BlurInOutProps`](/pixi-vn/index/interfaces/BlurInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: blurOut() (/pixi-vn/index/namespaces/transitions/functions/blurOut)



\> **blurOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1790](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1790)

Remove a image from the canvas with a blur effect: the image blurs out of focus before being
removed. See [blurIn](/pixi-vn/index/namespaces/transitions/functions/blurIn) and [BlurInOutProps](/pixi-vn/index/interfaces/BlurInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`BlurInOutProps`](/pixi-vn/index/interfaces/BlurInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: flashIn() (/pixi-vn/index/namespaces/transitions/functions/flashIn)



\> **flashIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1962](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1962)

Show a image in the canvas with a flash effect, with a configurable solid-color overlay (not
limited to a white flash). White reads as a camera/explosion-like flash, black as a blink/cut, and
arbitrary colors work for damage/magic/memory/UI transitions. See [FlashInOutProps](/pixi-vn/index/interfaces/FlashInOutProps).

If `alias` has no existing component, the new image appears immediately and the overlay fades in
and back out over it. If `alias` already has a component, the *current* content fades up to
`color` first, is swapped for the new content at the exact moment the screen is a solid `color`
(so the content change itself is invisible), and the new content then fades back down from `color`
to normal - see flashReplace.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`FlashInOutProps`](/pixi-vn/index/interfaces/FlashInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: flashOut() (/pixi-vn/index/namespaces/transitions/functions/flashOut)



\> **flashOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2038](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2038)

Remove a image from the canvas with a flash effect: a configurable solid-color overlay fades up to
`color` and back down to normal, and the image is removed the instant that finishes - the removal
itself is a hard cut, never an additional fade/dissolve. See [flashIn](/pixi-vn/index/namespaces/transitions/functions/flashIn) and
[FlashInOutProps](/pixi-vn/index/interfaces/FlashInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`FlashInOutProps`](/pixi-vn/index/interfaces/FlashInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: glitchIn() (/pixi-vn/index/namespaces/transitions/functions/glitchIn)



\> **glitchIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2442](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2442)

Show a image in the canvas with a glitch effect: the image materializes out of jittery bursts of
digital-corruption slices with red/blue fringing, which settle as it appears. See
[GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`GlitchInOutProps`](/pixi-vn/index/interfaces/GlitchInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: glitchOut() (/pixi-vn/index/namespaces/transitions/functions/glitchOut)



\> **glitchOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2461](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2461)

Remove a image from the canvas with a glitch effect: digital-corruption bursts build up until the
image is removed. See [glitchIn](/pixi-vn/index/namespaces/transitions/functions/glitchIn) and [GlitchInOutProps](/pixi-vn/index/interfaces/GlitchInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`GlitchInOutProps`](/pixi-vn/index/interfaces/GlitchInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: irisIn() (/pixi-vn/index/namespaces/transitions/functions/irisIn)



\> **irisIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1464](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1464)

Show a image in the canvas with an iris effect: the image is progressively revealed by an
expanding radial mask. Moving [IrisInOutProps.origin](/pixi-vn/index/interfaces/IrisInOutProps#origin) off-center makes the same primitive
useful as a focus/reveal effect (e.g. centered on a character).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`IrisInOutProps`](/pixi-vn/index/interfaces/IrisInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: irisOut() (/pixi-vn/index/namespaces/transitions/functions/irisOut)



\> **irisOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1534](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1534)

Remove a image from the canvas with an iris effect: the image is progressively concealed by a
contracting radial mask. See [irisIn](/pixi-vn/index/namespaces/transitions/functions/irisIn) and [IrisInOutProps](/pixi-vn/index/interfaces/IrisInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`IrisInOutProps`](/pixi-vn/index/interfaces/IrisInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: moveIn() (/pixi-vn/index/namespaces/transitions/functions/moveIn)



\> **moveIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:743](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L743)

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.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`MoveInOutProps`](/pixi-vn/index/interfaces/MoveInOutProps) & `object` = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: moveOut() (/pixi-vn/index/namespaces/transitions/functions/moveOut)



\> **moveOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:882](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L882)

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.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`MoveInOutProps`](/pixi-vn/index/interfaces/MoveInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: noiseDissolveIn() (/pixi-vn/index/namespaces/transitions/functions/noiseDissolveIn)



\> **noiseDissolveIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2713](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2713)

Show a image in the canvas with a noise dissolve: the image appears in organic, noise-shaped
blotches (or a cloudy fade with `edge: "soft"`) - the classic visual-novel image dissolve. See
[NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`NoiseDissolveInOutProps`](/pixi-vn/index/interfaces/NoiseDissolveInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: noiseDissolveOut() (/pixi-vn/index/namespaces/transitions/functions/noiseDissolveOut)



\> **noiseDissolveOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2732](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2732)

Remove a image from the canvas with a noise dissolve: the image disappears in noise-shaped
blotches and is then removed. See [noiseDissolveIn](/pixi-vn/index/namespaces/transitions/functions/noiseDissolveIn) and [NoiseDissolveInOutProps](/pixi-vn/index/interfaces/NoiseDissolveInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`NoiseDissolveInOutProps`](/pixi-vn/index/interfaces/NoiseDissolveInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: pinchIn() (/pixi-vn/index/namespaces/transitions/functions/pinchIn)



\> **pinchIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2888](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2888)

Show a image in the canvas with a pinch effect: the image emerges from a single point, deforming
outward as it settles (or puffs out of it with `mode: "bulge"`). See [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`PinchInOutProps`](/pixi-vn/index/interfaces/PinchInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: pinchOut() (/pixi-vn/index/namespaces/transitions/functions/pinchOut)



\> **pinchOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2907](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2907)

Remove a image from the canvas with a pinch effect: the image is sucked into a single point (or
puffs out with `mode: "bulge"`) and removed. See [pinchIn](/pixi-vn/index/namespaces/transitions/functions/pinchIn) and [PinchInOutProps](/pixi-vn/index/interfaces/PinchInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`PinchInOutProps`](/pixi-vn/index/interfaces/PinchInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: pixelateIn() (/pixi-vn/index/namespaces/transitions/functions/pixelateIn)



\> **pixelateIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1844](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1844)

Show a image in the canvas with a pixelate effect: the image appears pixelated and resolves into
focus. Useful for retro effects, digital transitions, censorship/stylization, or scene changes -
not only "glitch" scenes. See [PixelateInOutProps](/pixi-vn/index/interfaces/PixelateInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`PixelateInOutProps`](/pixi-vn/index/interfaces/PixelateInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: pixelateOut() (/pixi-vn/index/namespaces/transitions/functions/pixelateOut)



\> **pixelateOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1903](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1903)

Remove a image from the canvas with a pixelate effect: the image pixelates before being removed.
See [pixelateIn](/pixi-vn/index/namespaces/transitions/functions/pixelateIn) and [PixelateInOutProps](/pixi-vn/index/interfaces/PixelateInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`PixelateInOutProps`](/pixi-vn/index/interfaces/PixelateInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: pushIn() (/pixi-vn/index/namespaces/transitions/functions/pushIn)



\> **pushIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1188](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1188)

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.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`PushInOutProps`](/pixi-vn/index/interfaces/PushInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: pushOut() (/pixi-vn/index/namespaces/transitions/functions/pushOut)



\> **pushOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1314](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1314)

Remove a image from the canvas with a push effect. The image is pushed out to the outside of the canvas.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`PushInOutProps`](/pixi-vn/index/interfaces/PushInOutProps) = `...`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: removeWithDissolve() (/pixi-vn/index/namespaces/transitions/functions/removeWithDissolve)



\> **removeWithDissolve**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:595](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L595)

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 function is equivalent to [removeWithFade](/pixi-vn/index/namespaces/transitions/functions/removeWithFade).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`ShowWithDissolveTransitionProps`](/pixi-vn/index/interfaces/ShowWithDissolveTransitionProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: removeWithFade() (/pixi-vn/index/namespaces/transitions/functions/removeWithFade)



\> **removeWithFade**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:724](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L724)

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 function is equivalent to [removeWithDissolve](/pixi-vn/index/namespaces/transitions/functions/removeWithDissolve).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`ShowWithFadeTransitionProps`](/pixi-vn/index/interfaces/ShowWithFadeTransitionProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: rippleIn() (/pixi-vn/index/namespaces/transitions/functions/rippleIn)



\> **rippleIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2649](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2649)

Show a image in the canvas with a ripple effect: the image fades in through a ring of water-like
distortion spreading outward from an origin point - for dreams, magic or memories. See
[RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`RippleInOutProps`](/pixi-vn/index/interfaces/RippleInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: rippleOut() (/pixi-vn/index/namespaces/transitions/functions/rippleOut)



\> **rippleOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2668](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2668)

Remove a image from the canvas with a ripple effect: a ring of water-like distortion spreads over
the image as it fades out and is removed. See [rippleIn](/pixi-vn/index/namespaces/transitions/functions/rippleIn) and [RippleInOutProps](/pixi-vn/index/interfaces/RippleInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`RippleInOutProps`](/pixi-vn/index/interfaces/RippleInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: showWithDissolve() (/pixi-vn/index/namespaces/transitions/functions/showWithDissolve)



\> **showWithDissolve**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:513](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L513)

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 alias, then the image is replaced and the first image is removed after the effect is done.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`ShowWithDissolveTransitionProps`](/pixi-vn/index/interfaces/ShowWithDissolveTransitionProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: showWithFade() (/pixi-vn/index/namespaces/transitions/functions/showWithFade)



\> **showWithFade**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:635](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L635)

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 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.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`ShowWithFadeTransitionProps`](/pixi-vn/index/interfaces/ShowWithFadeTransitionProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: splitIn() (/pixi-vn/index/namespaces/transitions/functions/splitIn)



\> **splitIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1598](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1598)

Show a image in the canvas with a split effect: two mask panels slide together from the edges to
progressively reveal the image, meeting at the split line once fully shown. A configured
[SplitInOutProps](/pixi-vn/index/interfaces/SplitInOutProps) covers "curtain"-like effects without a story-specific API.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`SplitInOutProps`](/pixi-vn/index/interfaces/SplitInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: splitOut() (/pixi-vn/index/namespaces/transitions/functions/splitOut)



\> **splitOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1667](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1667)

Remove a image from the canvas with a split effect: two mask panels retract apart toward the
edges to progressively conceal the image. See [splitIn](/pixi-vn/index/namespaces/transitions/functions/splitIn) and [SplitInOutProps](/pixi-vn/index/interfaces/SplitInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`SplitInOutProps`](/pixi-vn/index/interfaces/SplitInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: tvIn() (/pixi-vn/index/namespaces/transitions/functions/tvIn)



\> **tvIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2819](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2819)

Show a image in the canvas like an old TV turning on: a bright dot stretches into a glowing
horizontal line, which then opens up into the full image, with CRT scanlines. The scale animates
around the component's own anchor/pivot, so a centered anchor looks best. See
[TvInOutProps](/pixi-vn/index/interfaces/TvInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`TvInOutProps`](/pixi-vn/index/interfaces/TvInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: tvOut() (/pixi-vn/index/namespaces/transitions/functions/tvOut)



\> **tvOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2839](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2839)

Remove a image from the canvas like an old TV turning off: the image collapses into a glowing
horizontal line, then into a dot, and is removed. The scale animates around the component's own
anchor/pivot, so a centered anchor looks best. See [tvIn](/pixi-vn/index/namespaces/transitions/functions/tvIn) and [TvInOutProps](/pixi-vn/index/interfaces/TvInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`TvInOutProps`](/pixi-vn/index/interfaces/TvInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: twistIn() (/pixi-vn/index/namespaces/transitions/functions/twistIn)



\> **twistIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2515](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2515)

Show a image in the canvas with a twist effect: the image unwinds out of a swirl, like coming
through a vortex or portal. See [TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`TwistInOutProps`](/pixi-vn/index/interfaces/TwistInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: twistOut() (/pixi-vn/index/namespaces/transitions/functions/twistOut)



\> **twistOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2534](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2534)

Remove a image from the canvas with a twist effect: the image winds up into a swirl before being
removed. See [twistIn](/pixi-vn/index/namespaces/transitions/functions/twistIn) and [TwistInOutProps](/pixi-vn/index/interfaces/TwistInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`TwistInOutProps`](/pixi-vn/index/interfaces/TwistInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: warpIn() (/pixi-vn/index/namespaces/transitions/functions/warpIn)



\> **warpIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:2581](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2581)

Show a image in the canvas with a warp effect: the image arrives out of radial zoom-blur streaks,
like dropping out of hyperspace. See [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`WarpInOutProps`](/pixi-vn/index/interfaces/WarpInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: warpOut() (/pixi-vn/index/namespaces/transitions/functions/warpOut)



\> **warpOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:2600](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L2600)

Remove a image from the canvas with a warp effect: the image streaks away in a radial zoom blur
before being removed. See [warpIn](/pixi-vn/index/namespaces/transitions/functions/warpIn) and [WarpInOutProps](/pixi-vn/index/interfaces/WarpInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`WarpInOutProps`](/pixi-vn/index/interfaces/WarpInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: wipeIn() (/pixi-vn/index/namespaces/transitions/functions/wipeIn)



\> **wipeIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1334)

Show a image in the canvas with a wipe effect: the image is progressively revealed by a moving
boundary. The direction/angle and inversion are all configurable, so the same primitive can
produce horizontal, vertical, or diagonal reveals - see [WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`WipeInOutProps`](/pixi-vn/index/interfaces/WipeInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: wipeOut() (/pixi-vn/index/namespaces/transitions/functions/wipeOut)



\> **wipeOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1402](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1402)

Remove a image from the canvas with a wipe effect: the image is progressively concealed by a
moving boundary. See [wipeIn](/pixi-vn/index/namespaces/transitions/functions/wipeIn) and [WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`WipeInOutProps`](/pixi-vn/index/interfaces/WipeInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# Function: zoomIn() (/pixi-vn/index/namespaces/transitions/functions/zoomIn)



\> **zoomIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:953](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L953)

Show a image in the canvas with a zoom effect. The image is zoomed in from the center of the canvas.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`ZoomInOutProps`](/pixi-vn/index/interfaces/ZoomInOutProps) & `object` = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.


# Function: zoomOut() (/pixi-vn/index/namespaces/transitions/functions/zoomOut)



\> **zoomOut**(`alias`, `props?`, `priority?`): `string`\[] | `undefined`

Defined in: [src/canvas/functions/canvas-transition.ts:1106](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1106)

Remove a image from the canvas with a zoom effect. The image is zoomed out to the center of the canvas.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the image. You can use this alias to refer to this image

### props? [#props]

[`ZoomInOutProps`](/pixi-vn/index/interfaces/ZoomInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#returns]

`string`\[] | `undefined`

The ids of the tickers that are used in the effect.


# transitions (/pixi-vn/index/namespaces/transitions)



## Functions [#functions]

* [blurIn](/pixi-vn/index/namespaces/transitions/functions/blurIn)
* [blurOut](/pixi-vn/index/namespaces/transitions/functions/blurOut)
* [flashIn](/pixi-vn/index/namespaces/transitions/functions/flashIn)
* [flashOut](/pixi-vn/index/namespaces/transitions/functions/flashOut)
* [glitchIn](/pixi-vn/index/namespaces/transitions/functions/glitchIn)
* [glitchOut](/pixi-vn/index/namespaces/transitions/functions/glitchOut)
* [irisIn](/pixi-vn/index/namespaces/transitions/functions/irisIn)
* [irisOut](/pixi-vn/index/namespaces/transitions/functions/irisOut)
* [moveIn](/pixi-vn/index/namespaces/transitions/functions/moveIn)
* [moveOut](/pixi-vn/index/namespaces/transitions/functions/moveOut)
* [noiseDissolveIn](/pixi-vn/index/namespaces/transitions/functions/noiseDissolveIn)
* [noiseDissolveOut](/pixi-vn/index/namespaces/transitions/functions/noiseDissolveOut)
* [pinchIn](/pixi-vn/index/namespaces/transitions/functions/pinchIn)
* [pinchOut](/pixi-vn/index/namespaces/transitions/functions/pinchOut)
* [pixelateIn](/pixi-vn/index/namespaces/transitions/functions/pixelateIn)
* [pixelateOut](/pixi-vn/index/namespaces/transitions/functions/pixelateOut)
* [pushIn](/pixi-vn/index/namespaces/transitions/functions/pushIn)
* [pushOut](/pixi-vn/index/namespaces/transitions/functions/pushOut)
* [removeWithDissolve](/pixi-vn/index/namespaces/transitions/functions/removeWithDissolve)
* [removeWithFade](/pixi-vn/index/namespaces/transitions/functions/removeWithFade)
* [rippleIn](/pixi-vn/index/namespaces/transitions/functions/rippleIn)
* [rippleOut](/pixi-vn/index/namespaces/transitions/functions/rippleOut)
* [showWithDissolve](/pixi-vn/index/namespaces/transitions/functions/showWithDissolve)
* [showWithFade](/pixi-vn/index/namespaces/transitions/functions/showWithFade)
* [splitIn](/pixi-vn/index/namespaces/transitions/functions/splitIn)
* [splitOut](/pixi-vn/index/namespaces/transitions/functions/splitOut)
* [tvIn](/pixi-vn/index/namespaces/transitions/functions/tvIn)
* [tvOut](/pixi-vn/index/namespaces/transitions/functions/tvOut)
* [twistIn](/pixi-vn/index/namespaces/transitions/functions/twistIn)
* [twistOut](/pixi-vn/index/namespaces/transitions/functions/twistOut)
* [warpIn](/pixi-vn/index/namespaces/transitions/functions/warpIn)
* [warpOut](/pixi-vn/index/namespaces/transitions/functions/warpOut)
* [wipeIn](/pixi-vn/index/namespaces/transitions/functions/wipeIn)
* [wipeOut](/pixi-vn/index/namespaces/transitions/functions/wipeOut)
* [zoomIn](/pixi-vn/index/namespaces/transitions/functions/zoomIn)
* [zoomOut](/pixi-vn/index/namespaces/transitions/functions/zoomOut)


# Type Alias: AllFederatedEventMap (/pixi-vn/index/type-aliases/AllFederatedEventMap)



\> **AllFederatedEventMap** = `FederatedEventMap` & `GlobalFederatedEventMap`

Defined in: node_modules/pixi.js/lib/events/FederatedEventMap.d.ts:55

The types for the events that can be emitted by a Container

## Advanced [#advanced]


# Type Alias: AssetAliasIdType (/pixi-vn/index/type-aliases/AssetAliasIdType)



\> **AssetAliasIdType** = \[keyof [`PixivnAssetAliasIds`](/pixi-vn/index/interfaces/PixivnAssetAliasIds)] *extends* \[`never`] ? `string` : keyof [`PixivnAssetAliasIds`](/pixi-vn/index/interfaces/PixivnAssetAliasIds)

Defined in: [src/canvas/types/AssetAliasIdType.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/AssetAliasIdType.ts#L37)

The type used wherever an asset alias is expected (e.g. `Assets.load`, `getTexture`).

* **Default** — resolves to `string` so that existing code that passes arbitrary strings
  continues to compile without any changes.
* **Augmented** — when [PixivnAssetAliasIds](/pixi-vn/index/interfaces/PixivnAssetAliasIds) has been extended via
  `declare module "@drincs/pixi-vn/canvas"`, this type resolves to the union of the
  declared keys, giving you compile-time safety against typos and unknown asset aliases.


# Type Alias: AssetSrc (/pixi-vn/index/type-aliases/AssetSrc)



\> **AssetSrc** = `ArrayOr`\<`string`> | `ArrayOr`\<[`ResolvedSrc`](/pixi-vn/index/interfaces/ResolvedSrc)> & `object`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:164

A valid asset source specification. This can be a URL string, a [ResolvedSrc](/pixi-vn/index/interfaces/ResolvedSrc),
or an array of either. The source defines where and how to load an asset.

## Example [#example]

```ts
// Single URL string
const src: AssetSrc = 'images/sprite.png';

// Multiple format options
const src: AssetSrc = ['sprite.webp', 'sprite.png'];

// With format pattern
const src: AssetSrc = 'sprite.{webp,png}';

// Resolved source with options
const src: AssetSrc = {
    src: 'sprite.png',
    format: 'png',
    parser: 'texture',
    data: {
        scaleMode: 'nearest',
    }
};

// Array of resolved sources
const src: AssetSrc = [
    {
        src: 'sprite@2x.webp',
        format: 'webp',
    },
    {
        src: 'sprite.png',
        format: 'png',
    }
];
```

## Remarks [#remarks]

When specifying multiple formats:

* The format that is selected will depend on AssetInitOptions.texturePreference
* Resolution is parsed from file names
* Custom data can be passed to loaders

## See [#see]

* [ResolvedSrc](/pixi-vn/index/interfaces/ResolvedSrc) For resolved source format
* Assets.add For adding assets with sources

## Standard [#standard]


# Type Alias: BundleIdType (/pixi-vn/index/type-aliases/BundleIdType)



\> **BundleIdType** = \[keyof [`PixivnBundleIds`](/pixi-vn/index/interfaces/PixivnBundleIds)] *extends* \[`never`] ? `string` : keyof [`PixivnBundleIds`](/pixi-vn/index/interfaces/PixivnBundleIds)

Defined in: [src/canvas/types/BundleIdType.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/BundleIdType.ts#L37)

The type used wherever an asset bundle name is expected (e.g. `Assets.loadBundle`).

* **Default** — resolves to `string` so that existing code that passes arbitrary strings
  continues to compile without any changes.
* **Augmented** — when [PixivnBundleIds](/pixi-vn/index/interfaces/PixivnBundleIds) has been extended via
  `declare module "@drincs/pixi-vn/canvas"`, this type resolves to the union of the
  declared keys, giving you compile-time safety against typos and unknown bundle names.


# Type Alias: CharacterIdType (/pixi-vn/index/type-aliases/CharacterIdType)



\> **CharacterIdType** = \[keyof [`PixivnCharacterIds`](/pixi-vn/index/interfaces/PixivnCharacterIds)] *extends* \[`never`] ? `string` : keyof [`PixivnCharacterIds`](/pixi-vn/index/interfaces/PixivnCharacterIds)

Defined in: [src/characters/types/CharacterIdType.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/characters/types/CharacterIdType.ts#L38)

The type used wherever a character ID is expected (e.g. `RegisteredCharacters.get`,
`RegisteredCharacters.has`, character constructors, …).

* **Default** — resolves to `string` so that existing code that passes arbitrary strings
  continues to compile without any changes.
* **Augmented** — when [PixivnCharacterIds](/pixi-vn/index/interfaces/PixivnCharacterIds) has been extended via
  `declare module "@drincs/pixi-vn/characters"`, this type resolves to the union of the
  declared keys, giving you compile-time safety against typos and unknown character IDs.


# Type Alias: ColorType (/pixi-vn/index/type-aliases/ColorType)



\> **ColorType** = `string` | `number` | `number`\[] | [`RgbColorType`](/pixi-vn/index/interfaces/RgbColorType) | [`RgbaColorType`](/pixi-vn/index/interfaces/RgbaColorType) | [`HslColorType`](/pixi-vn/index/interfaces/HslColorType) | [`HslaColorType`](/pixi-vn/index/interfaces/HslaColorType) | [`HsvColorType`](/pixi-vn/index/interfaces/HsvColorType) | [`HsvaColorType`](/pixi-vn/index/interfaces/HsvaColorType)

Defined in: [src/canvas/types/ColorType.ts:39](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ColorType.ts#L39)

A color, accepted wherever Pixi'VN takes one (e.g. [FlashInOutProps.color](/pixi-vn/index/interfaces/FlashInOutProps#color)): a hex number
(`0xff0000`), a CSS-style string (`"#f00"`, `"red"`, `"rgb(255, 0, 0)"`, ...), an `[r, g, b]`/
`[r, g, b, a]` array, or one of the plain RGB(A)/HSL(A)/HSV(A) object shapes above.

This is a JSON-serializable subset of `pixi.js`'s own `ColorSource` (which every value here is
still assignable to, so it can be passed straight into `Graphics.fill()`/`tint`/etc. unchanged) -
deliberately excluding `Float32Array`/`Uint8Array`/`Uint8ClampedArray` (which survive a
`JSON.stringify`/`JSON.parse` round-trip but lose their typed-array-ness, coming back as a plain
`{0: r, 1: g, ...}` object) and PixiJS's own `Color` class instance (not serializable at all). Both
would break `createExportableElement()` (ticker args, saved game state, ...) the same way a live
`Filter`/callback reference did elsewhere in the codebase.


# Type Alias: CommonTickerProps (/pixi-vn/index/type-aliases/CommonTickerProps)



\> **CommonTickerProps** = `object`

Defined in: [src/tickers/types/CommonTickerProps.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L1)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string`\[] | `string`

Defined in: [src/tickers/types/CommonTickerProps.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L6)

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: [src/tickers/types/CommonTickerProps.ts:27](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L27)

A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
When true, calling `narration.continue()` forces the current content to complete before advancing to the next narrative step.

#### Default [#default-1]

```ts
false
```

***

### startOnlyIfHaveTexture? [#startonlyifhavetexture]

\> `optional` **startOnlyIfHaveTexture?**: `boolean`

Defined in: [src/tickers/types/CommonTickerProps.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L11)

If true, the effect only starts if the canvas element have a texture

#### Default [#default-2]

```ts
false
```

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string`\[] | `string`

Defined in: [src/tickers/types/CommonTickerProps.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L16)

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-3]

```ts
[]
```

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string`\[] | `string`

Defined in: [src/tickers/types/CommonTickerProps.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/types/CommonTickerProps.ts#L21)

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-4]

```ts
[]
```


# Type Alias: ContainerChild (/pixi-vn/index/type-aliases/ContainerChild)



\> **ContainerChild** = `PixiContainer` & [`CanvasBaseItem`](/pixi-vn/index/classes/CanvasBaseItem)\<`any`>

Defined in: [src/canvas/types/ContainerChild.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/types/ContainerChild.ts#L4)


# Type Alias: ErrorCodeType (/pixi-vn/index/type-aliases/ErrorCodeType)



\> **ErrorCodeType** = `"obsolete_save"` | `"unknown_element"` | `"unregistered_element"` | `"unregistered_asset"` | `"not_json_serializable"` | `"not_implemented"` | `"invalid_usage"` | `"unhandled_error"`

Defined in: [src/core/ErrorCodeType.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/ErrorCodeType.ts#L1)


# Type Alias: GameWorkerHandler (/pixi-vn/index/type-aliases/GameWorkerHandler)



\> **GameWorkerHandler** = (`payload`) => `unknown` | `Promise`\<`unknown`>

Defined in: [src/worker/GameWorkerHandlerRegistry.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/GameWorkerHandlerRegistry.ts#L1)

## Parameters [#parameters]

### payload [#payload]

`unknown`

## Returns [#returns]

`unknown` | `Promise`\<`unknown`>


# Type Alias: GameWorkerRequest (/pixi-vn/index/type-aliases/GameWorkerRequest)



\> **GameWorkerRequest** = \{ `diff`: `Difference`\[]; `id`: `number`; `state`: `object`; `type`: `"restore-diff"`; } | \{ `after`: `object`; `before`: `object`; `id`: `number`; `type`: `"diff"`; } | \{ `id`: `number`; `type`: `"clone"`; `value`: `object`; } | \{ `id`: `number`; `kind`: `string`; `payload`: `unknown`; `type`: `"custom"`; }

Defined in: [src/worker/interfaces/GameWorkerMessage.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/interfaces/GameWorkerMessage.ts#L13)

Message protocol between the main thread and an optional GameWorker-registered
Worker. Kept intentionally small: each request names one unit of work Pixi'VN (or a
third-party library building on it, via `"custom"` - see `registerGameWorkerHandler`) knows
how to hand off, and the worker replies with the same `id` so the caller can match the
response.

This protocol (and everything it carries) only ever deals with plain, structured-clone-safe
data - never PixiJS/canvas/audio objects, which can't leave the main thread.

## Union Members [#union-members]

### Type Literal [#type-literal]

\{ `diff`: `Difference`\[]; `id`: `number`; `state`: `object`; `type`: `"restore-diff"`; }

#### diff [#diff]

\> **diff**: `Difference`\[]

#### id [#id]

\> **id**: `number`

#### state [#state]

\> **state**: `object`

The base state to apply `diff` to (not mutated).

#### type [#type]

\> **type**: `"restore-diff"`

***

### Type Literal [#type-literal-1]

\{ `after`: `object`; `before`: `object`; `id`: `number`; `type`: `"diff"`; }

#### after [#after]

\> **after**: `object`

#### before [#before]

\> **before**: `object`

The two states to compare (neither is mutated).

#### id [#id-1]

\> **id**: `number`

#### type [#type-1]

\> **type**: `"diff"`

***

### Type Literal [#type-literal-2]

\{ `id`: `number`; `type`: `"clone"`; `value`: `object`; }

#### id [#id-2]

\> **id**: `number`

#### type [#type-2]

\> **type**: `"clone"`

#### value [#value]

\> **value**: `object`

The value to deep-clone.

***

### Type Literal [#type-literal-3]

\{ `id`: `number`; `kind`: `string`; `payload`: `unknown`; `type`: `"custom"`; }

#### id [#id-3]

\> **id**: `number`

#### kind [#kind]

\> **kind**: `string`

Identifies which registered handler (see `registerGameWorkerHandler`) should run.

#### payload [#payload]

\> **payload**: `unknown`

#### type [#type-3]

\> **type**: `"custom"`


# Type Alias: GameWorkerResponse (/pixi-vn/index/type-aliases/GameWorkerResponse)



\> **GameWorkerResponse** = \{ `id`: `number`; `result`: `object`; `type`: `"restore-diff-result"`; } | \{ `id`: `number`; `result`: `Difference`\[]; `type`: `"diff-result"`; } | \{ `id`: `number`; `result`: `object`; `type`: `"clone-result"`; } | \{ `id`: `number`; `result`: `unknown`; `type`: `"custom-result"`; } | \{ `error`: `string`; `id`: `number`; `type`: `"error"`; }

Defined in: [src/worker/interfaces/GameWorkerMessage.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/worker/interfaces/GameWorkerMessage.ts#L42)


# Type Alias: HistoryChoiceMenuOption (/pixi-vn/index/type-aliases/HistoryChoiceMenuOption)



\> **HistoryChoiceMenuOption** = `object`

Defined in: [src/narration/types/HistoryChoiceMenuOption.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/HistoryChoiceMenuOption.ts#L7)

HistoryChoiceMenuOption is a type that contains the history information of a choice menu option.

## Properties [#properties]

### hidden [#hidden]

\> **hidden**: `boolean`

Defined in: [src/narration/types/HistoryChoiceMenuOption.ts:23](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/HistoryChoiceMenuOption.ts#L23)

The choice is hidden

***

### isResponse [#isresponse]

\> **isResponse**: `boolean`

Defined in: [src/narration/types/HistoryChoiceMenuOption.ts:19](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/HistoryChoiceMenuOption.ts#L19)

This choice is a response

***

### text [#text]

\> **text**: `string` | `string`\[]

Defined in: [src/narration/types/HistoryChoiceMenuOption.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/HistoryChoiceMenuOption.ts#L11)

Text to be displayed in the menu

***

### type [#type]

\> **type**: `CloseType` | [`LabelRunModeType`](/pixi-vn/index/type-aliases/LabelRunModeType)

Defined in: [src/narration/types/HistoryChoiceMenuOption.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/HistoryChoiceMenuOption.ts#L15)

Method used to open the label, or close the menu.


# Type Alias: HistoryGoBackModeType (/pixi-vn/index/type-aliases/HistoryGoBackModeType)



\> **HistoryGoBackModeType** = `"step"` | `"paragraph"`

Defined in: [src/history/HistoryManagerStatic.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/HistoryManagerStatic.ts#L14)

How often a go-back-able checkpoint is recorded:

* `"step"` (default): every single narration step, matching visual-novel-style games
  where the player may want to undo one line/sprite change at a time.
* `"paragraph"`: only when a new paragraph starts (the number of opened labels
  changes), a choice is proposed, or an input is requested - matching book-style
  narrations where undoing mid-paragraph doesn't make sense to the player.


# Type Alias: InputInfo (/pixi-vn/index/type-aliases/InputInfo)



\> **InputInfo** = `object`

Defined in: [src/narration/types/InputInfo.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/InputInfo.ts#L1)

## Properties [#properties]

### isRequired? [#isrequired]

\> `optional` **isRequired?**: `boolean`

Defined in: [src/narration/types/InputInfo.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/InputInfo.ts#L2)

***

### type? [#type]

\> `optional` **type?**: `string`

Defined in: [src/narration/types/InputInfo.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/InputInfo.ts#L3)


# Type Alias: LabelIdType (/pixi-vn/index/type-aliases/LabelIdType)



\> **LabelIdType** = \[keyof [`PixivnLabelIds`](/pixi-vn/index/interfaces/PixivnLabelIds)] *extends* \[`never`] ? `string` : keyof [`PixivnLabelIds`](/pixi-vn/index/interfaces/PixivnLabelIds)

Defined in: [src/narration/types/LabelIdType.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/LabelIdType.ts#L38)

The type used wherever a label ID is expected (e.g. `narration.call`, `narration.jump`,
`newLabel`, choice options, …).

* **Default** — resolves to `string` so that existing code that passes arbitrary strings
  continues to compile without any changes.
* **Augmented** — when [PixivnLabelIds](/pixi-vn/index/interfaces/PixivnLabelIds) has been extended via
  `declare module "@drincs/pixi-vn/narration"`, this type resolves to the union of the
  declared keys, giving you compile-time safety against typos and unknown label IDs.


# Type Alias: LabelRunModeType (/pixi-vn/index/type-aliases/LabelRunModeType)



\> **LabelRunModeType** = `"call"` | `"jump"`

Defined in: [src/narration/types/LabelRunModeType.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/LabelRunModeType.ts#L1)


# Type Alias: LabelSteps<T> (/pixi-vn/index/type-aliases/LabelSteps)



\> **LabelSteps**\<`T`> = \[[`StepLabelType`](/pixi-vn/index/type-aliases/StepLabelType)\<`T`>, `...StepLabelType<Partial<T>>[]`]

Defined in: [src/narration/types/LabelSteps.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/LabelSteps.ts#L3)

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object`


# Type Alias: Layer (/pixi-vn/index/type-aliases/Layer)



\> **Layer** = `PixiContainer`\<`ContainerChild`>

Defined in: [src/canvas/components/Layer.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/components/Layer.ts#L3)


# Type Alias: LoadParserName (deprecated) (/pixi-vn/index/type-aliases/LoadParserName)



\> **LoadParserName** = `"loadJson"` | `"loadSvg"` | `"loadTextures"` | `"loadTxt"` | `"loadVideo"` | `"loadWebFont"` | `string` & `object`

Defined in: node_modules/pixi.js/lib/assets/types.d.ts:12

## Deprecated [#deprecated]

Use AssetParser instead.

## Advanced [#advanced]


# Type Alias: MotionAnimationOptions (/pixi-vn/index/type-aliases/MotionAnimationOptions)



\> **MotionAnimationOptions** = `ValueAnimationWithDynamicDelay` & `ReduceMotionOption` | `ValueAnimationWithDynamicDelay` & `ReduceMotionOption` & `StyleTransitions` & `SVGPathTransitions` & `SVGForcedAttrTransitions` & `SVGTransitions` & `VariableTransitions` & `object`

Defined in: node_modules/motion-dom/dist/index.d.ts:2382


# Type Alias: OnErrorHandler (/pixi-vn/index/type-aliases/OnErrorHandler)



\> **OnErrorHandler** = (`error`, `props`) => `void` | `Promise`\<`void`>

Defined in: [src/core/OnErrorHandler.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/core/OnErrorHandler.ts#L7)

Type for on-error handlers. Handlers accept the error object and the step
props; they may be synchronous or asynchronous.

## Parameters [#parameters]

### error [#error]

`unknown`

### props [#props]

`Partial`\<`StepLabelProps`>

## Returns [#returns]

`void` | `Promise`\<`void`>


# Type Alias: StepLabelPropsType<T> (/pixi-vn/index/type-aliases/StepLabelPropsType)



\> **StepLabelPropsType**\<`T`> = `StepLabelProps` & `T`

Defined in: [src/narration/types/StepLabelType.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/StepLabelType.ts#L16)

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }


# Type Alias: StepLabelResultType (/pixi-vn/index/type-aliases/StepLabelResultType)



\> **StepLabelResultType** = `StepLabelResult` | `void` | `string`

Defined in: [src/narration/types/StepLabelType.ts:15](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/StepLabelType.ts#L15)

Result of a [StepLabelType](/pixi-vn/index/type-aliases/StepLabelType) execution.

* `StepLabelResult`: a structured result consumed by the narration engine.
* `void`: the step completed without returning an explicit result.
* `string`: a simple token or message interpreted by higher-level logic.

Prefer returning a well-typed [StepLabelResult](/pixi-vn/index/interfaces/StepLabelResult) for anything that
needs to be consumed programmatically. Use plain strings only where a
lightweight, convention-based signal is sufficient and clearly documented
by the surrounding game logic.


# Type Alias: StepLabelType<T> (/pixi-vn/index/type-aliases/StepLabelType)



\> **StepLabelType**\<`T`> = (`props`, `info`) => [`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>

Defined in: [src/narration/types/StepLabelType.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/types/StepLabelType.ts#L21)

StepLabel is a function that will be executed as the game continues.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = \{ }

## Parameters [#parameters]

### props [#props]

[`StepLabelPropsType`](/pixi-vn/index/type-aliases/StepLabelPropsType)\<`T`>

### info [#info]

#### labelId [#labelid]

`string`

The id of the label.

## Returns [#returns]

[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType) | `Promise`\<[`StepLabelResultType`](/pixi-vn/index/type-aliases/StepLabelResultType)>


# Type Alias: StorageElementType (/pixi-vn/index/type-aliases/StorageElementType)



\> **StorageElementType** = `StorageElementInternalType` | `Record`\<`string` | `number` | `symbol`, `StorageElementInternalType`> | \{\[`key`: `string` | `number` | `symbol`]: `StorageElementType`; } | [`StorageObjectType`](/pixi-vn/index/type-aliases/StorageObjectType)\[] | (`StorageElementPrimaryType` | `StorageElementInternalType` | `StorageElementType`)\[] | \{\[`key`: `string` | `number` | `symbol`]: `NonFunctionStorage`; }

Defined in: [src/storage/types/StorageElementType.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/types/StorageElementType.ts#L25)

StorageElementType are all the types that can be stored in the storage


# Type Alias: StorageObjectType (/pixi-vn/index/type-aliases/StorageObjectType)



\> **StorageObjectType** = `Record`\<`string` | `number` | `symbol`, [`StorageElementType`](/pixi-vn/index/type-aliases/StorageElementType)>

Defined in: [src/storage/types/StorageElementType.ts:35](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/types/StorageElementType.ts#L35)

StorageObjectType are all the types that can be stored in the storage


# Type Alias: StoredChoiceInterface (/pixi-vn/index/type-aliases/StoredChoiceInterface)



\> **StoredChoiceInterface** = [`ChoiceOptionInterface`](/pixi-vn/index/interfaces/ChoiceOptionInterface) | [`CloseChoiceOptionInterface`](/pixi-vn/index/interfaces/CloseChoiceOptionInterface)

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:30](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L30)


# Type Alias: StoredIndexedChoiceInterface (/pixi-vn/index/type-aliases/StoredIndexedChoiceInterface)



\> **StoredIndexedChoiceInterface** = [`StoredChoiceInterface`](/pixi-vn/index/type-aliases/StoredChoiceInterface) & `object`

Defined in: [src/narration/interfaces/StoredChoiceInterface.ts:31](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/interfaces/StoredChoiceInterface.ts#L31)

## Type Declaration [#type-declaration]

### choiceIndex [#choiceindex]

\> **choiceIndex**: `number`

Is the index of the choice in the menu. It is used to identify the choice when it is selected.


# Type Alias: TextureSourceLike (/pixi-vn/index/type-aliases/TextureSourceLike)



\> **TextureSourceLike** = `TextureSource` | `TextureResourceOrOptions` | `string`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/Texture.d.ts:90

A texture source can be a string, an image, a video, a canvas, or a texture resource.

## Advanced [#advanced]

## See [#see]

* TextureSource
* TextureResourceOrOptions
* Texture.from


# Type Alias: TickerProgrationType (/pixi-vn/index/type-aliases/TickerProgrationType)



\> **TickerProgrationType** = [`TickerProgrationLinear`](/pixi-vn/index/interfaces/TickerProgrationLinear) | [`TickerProgrationExponential`](/pixi-vn/index/interfaces/TickerProgrationExponential)

Defined in: [src/tickers/interfaces/TickerProgrationType.ts:1](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/interfaces/TickerProgrationType.ts#L1)


# Variable: Assets (/pixi-vn/index/variables/Assets)



\> **Assets**: `AssetsClass`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: CANVAS_APP_GAME_LAYER_ALIAS (/pixi-vn/index/variables/CANVAS_APP_GAME_LAYER_ALIAS)



\> `const` **CANVAS_APP_GAME_LAYER_ALIAS**: `"__game_layer__"` = `"__game_layer__"`

Defined in: [src/constants.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/constants.ts#L6)

Is a special alias to indicate the game layer.


# Variable: Color (/pixi-vn/index/variables/Color)



\> **Color**: *typeof* `Color`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: PIXIVN_VERSION (/pixi-vn/index/variables/PIXIVN_VERSION)



\> **PIXIVN_VERSION**: `string` = `"1.9.4"`

Defined in: [package.json:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/package.json#L3)


# Variable: Rectangle (/pixi-vn/index/variables/Rectangle)



\> **Rectangle**: *typeof* `Rectangle`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: SYSTEM_RESERVED_STORAGE_KEYS (/pixi-vn/index/variables/SYSTEM_RESERVED_STORAGE_KEYS)



\> `const` **SYSTEM_RESERVED_STORAGE_KEYS**: `object`

Defined in: [src/constants.ts:24](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/constants.ts#L24)

## Type Declaration [#type-declaration]

### ADD_NEXT_DIALOG_TEXT_INTO_THE_CURRENT_DIALOG_FLAG_KEY [#add_next_dialog_text_into_the_current_dialog_flag_key]

\> **ADD_NEXT_DIALOG_TEXT_INTO_THE_CURRENT_DIALOG_FLAG_KEY**: `string` = `"___glue___"`

This variable is used to add the next dialog text into the current dialog memory.
This value was added to introduce Ink Glue functionality [https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue)

### ALL_CHOICES_MADE_KEY [#all_choices_made_key]

\> **ALL_CHOICES_MADE_KEY**: `string` = `"choices:made"`

The key of a list of all choices that have been made during the progression of the steps.

### CHARACTER_CATEGORY_KEY [#character_category_key]

\> **CHARACTER_CATEGORY_KEY**: `string` = `"character"`

The key of the characters memory

### CURRENT_DIALOGUE_MEMORY_KEY [#current_dialogue_memory_key]

\> **CURRENT_DIALOGUE_MEMORY_KEY**: `string` = `"dialogue"`

The key of the current dialogue memory

### CURRENT_INPUT_INFO_MEMORY_KEY [#current_input_info_memory_key]

\> **CURRENT_INPUT_INFO_MEMORY_KEY**: `string` = `"input:info"`

The key of the current input info

### CURRENT_INPUT_VALUE_MEMORY_KEY [#current_input_value_memory_key]

\> **CURRENT_INPUT_VALUE_MEMORY_KEY**: `string` = `"input:value"`

The key of the input memory. This value can be read by pixi-vn json importer

### CURRENT_MENU_OPTIONS_MEMORY_KEY [#current_menu_options_memory_key]

\> **CURRENT_MENU_OPTIONS_MEMORY_KEY**: `string` = `"choice:options"`

The key of the current menu options memory

### CURRENT_STEP_TIMES_COUNTER_KEY [#current_step_times_counter_key]

\> **CURRENT_STEP_TIMES_COUNTER_KEY**: `string` = `"label:history"`

The key of the current step times counter.
This value was added to introduce Ink Sequences, cycles and other alternatives [https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#sequences-cycles-and-other-alternatives](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#sequences-cycles-and-other-alternatives)

### LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY [#last_dialogue_added_in_step_memory_key]

\> **LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY**: `string` = `"dialogue:step_counter"`

The key of step counter of the current dialogue memory

### LAST_INPUT_ADDED_IN_STEP_MEMORY_KEY [#last_input_added_in_step_memory_key]

\> **LAST_INPUT_ADDED_IN_STEP_MEMORY_KEY**: `string` = `"input:step_counter"`

The key of the last input added in the step memory

### LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY [#last_menu_options_added_in_step_memory_key]

\> **LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY**: `string` = `"choice:step_counter"`

The key of the last menu options added in the step memory

### LAST_STEP_GLUED [#last_step_glued]

\> **LAST_STEP_GLUED**: `string` = `"glue:last_step"`

The key of the last dialogue step glued in the step memory

### OPENED_LABELS_COUNTER_KEY [#opened_labels_counter_key]

\> **OPENED_LABELS_COUNTER_KEY**: `string` = `"label:opened"`

The key of a list of all labels that have been opened during the progression of the steps.


# Variable: TextStyle (/pixi-vn/index/variables/TextStyle)



\> **TextStyle**: *typeof* `TextStyle`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: Texture (/pixi-vn/index/variables/Texture)



\> **Texture**: *typeof* `Texture`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: UPDATE_PRIORITY (/pixi-vn/index/variables/UPDATE_PRIORITY)



\> **UPDATE_PRIORITY**: *typeof* `UPDATE_PRIORITY`

Defined in: [src/canvas/index.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L8)


# Variable: canvas (/pixi-vn/index/variables/canvas)



\> `const` **canvas**: [`CanvasManagerInterface`](/pixi-vn/index/interfaces/CanvasManagerInterface)

Defined in: [src/canvas/index.ts:143](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/index.ts#L143)


# Variable: default (/pixi-vn/index/variables/default)



\> **default**: `object`

Defined in: [src/index.ts:558](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/index.ts#L558)

## Type Declaration [#type-declaration]

### canvas [#canvas]

\> **canvas**: [`CanvasManagerInterface`](/pixi-vn/index/interfaces/CanvasManagerInterface) = `canvasUtils.canvas`

### CANVAS_APP_GAME_LAYER_ALIAS [#canvas_app_game_layer_alias]

\> **CANVAS_APP_GAME_LAYER_ALIAS**: `string`

Is a special alias to indicate the game layer.

### canvasUtils [#canvasutils]

\> **canvasUtils**: `__module`

### characterUtils [#characterutils]

\> **characterUtils**: `__module`

### Game [#game]

\> **Game**: *typeof* [`Game`](/pixi-vn/index/namespaces/Game)

### GameUnifier [#gameunifier]

\> **GameUnifier**: *typeof* [`GameUnifier`](/pixi-vn/index/classes/GameUnifier)

### history [#history]

\> **history**: [`HistoryManagerInterface`](/pixi-vn/index/interfaces/HistoryManagerInterface) = `historyUtils.stepHistory`

### narration [#narration]

\> **narration**: [`NarrationManagerInterface`](/pixi-vn/index/interfaces/NarrationManagerInterface) = `narrationUtils.narration`

### narrationUtils [#narrationutils]

\> **narrationUtils**: `__module`

### PIXIVN_VERSION [#pixivn_version]

\> **PIXIVN_VERSION**: `string`

### sound [#sound]

\> **sound**: [`SoundManagerInterface`](/pixi-vn/index/interfaces/SoundManagerInterface) = `soundUtils.sound`

### soundUtils [#soundutils]

\> **soundUtils**: `__module`

### storage [#storage]

\> **storage**: [`StorageManagerInterface`](/pixi-vn/index/interfaces/StorageManagerInterface) = `storageUtils.storage`

### tickers [#tickers]

\> **tickers**: [`CanvasTickersInterface`](/pixi-vn/index/interfaces/CanvasTickersInterface)

Namespace for operations on tickers - the frame-by-frame animation primitive every Pixi'VN
animation (`canvas.animate`, transitions, custom `TickerBase` subclasses) is built on.

### createExportableElement() [#createexportableelement]

\> **createExportableElement**\<`T`>(`element`): `T`

This function is used to create a deep copy of the element

#### Type Parameters [#type-parameters]

##### T [#t]

`T`

#### Parameters [#parameters]

##### element [#element]

`T`

The element to be copied

#### Returns [#returns]

`T`

The copied element

#### Throws [#throws]

when the element is not JSON serializable (e.g. contains functions or class instances).


# Variable: narration (/pixi-vn/index/variables/narration)



\> `const` **narration**: [`NarrationManagerInterface`](/pixi-vn/index/interfaces/NarrationManagerInterface)

Defined in: [src/narration/index.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/narration/index.ts#L42)


# Variable: sound (/pixi-vn/index/variables/sound)



\> `const` **sound**: [`SoundManagerInterface`](/pixi-vn/index/interfaces/SoundManagerInterface)

Defined in: [src/sound/index.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/index.ts#L28)

The singleton sound manager instance. Use this to play and manage sounds in your game.


# Variable: stepHistory (/pixi-vn/index/variables/stepHistory)



\> `const` **stepHistory**: [`HistoryManagerInterface`](/pixi-vn/index/interfaces/HistoryManagerInterface)

Defined in: [src/history/index.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/history/index.ts#L12)


# Variable: storage (/pixi-vn/index/variables/storage)



\> `const` **storage**: [`StorageManagerInterface`](/pixi-vn/index/interfaces/StorageManagerInterface)

Defined in: [src/storage/index.ts:14](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/storage/index.ts#L14)


# Variable: tickers (/pixi-vn/index/variables/tickers)



\> `const` **tickers**: [`CanvasTickersInterface`](/pixi-vn/index/interfaces/CanvasTickersInterface)

Defined in: [src/tickers/index.ts:557](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/tickers/index.ts#L557)

Namespace for operations on tickers - the frame-by-frame animation primitive every Pixi'VN
animation (`canvas.animate`, transitions, custom `TickerBase` subclasses) is built on.


# @drincs/pixi-vn (/pixi-vn/modules)



## Modules [#modules]

* [index](/pixi-vn/index)
* [vite](/pixi-vn/vite)
* [vite-listener](/pixi-vn/vite-listener)


# Function: isViteDevelopmentMode() (/pixi-vn/vite-listener/functions/isViteDevelopmentMode)



\> **isViteDevelopmentMode**(): `boolean`

Defined in: [src/vite-listener/plugins.ts:56](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite-listener/plugins.ts#L56)

Checks if the current runtime is Vite development mode.
Detects Vite dev client script injected in development.
Assumes default Vite client path starts with `/@vite/client`.

## Returns [#returns]

`boolean`


# Function: setupPixivnViteData() (/pixi-vn/vite-listener/functions/setupPixivnViteData)



\> **setupPixivnViteData**(): `Promise`\<`void`>

Defined in: [src/vite-listener/plugins.ts:86](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite-listener/plugins.ts#L86)

Initializes Pixi VN development tools by syncing game state with the Vite dev server.
Sends assets manifest and canvas options.

**Note:** This function only operates in Vite development mode and is a no-op in production.

**Call this function:** After RegisteredCharacters and RegisteredLabels are populated,
typically in your client-side initialization code.

## Returns [#returns]

`Promise`\<`void`>

## Example [#example]

```ts
// In your main game initialization file
import { setupPixivnViteData } from '@drincs/pixi-vn/vite-listener';

await Promise.all([import("@/content")]);
// After game setup
await setupPixivnViteData();
```


# vite-listener (/pixi-vn/vite-listener)



## Functions [#functions]

* [isViteDevelopmentMode](/pixi-vn/vite-listener/functions/isViteDevelopmentMode)
* [setupPixivnViteData](/pixi-vn/vite-listener/functions/setupPixivnViteData)


# Function: vitePluginPixivn() (/pixi-vn/vite/functions/vitePluginPixivn)



\> **vitePluginPixivn**(`options?`): `Plugin`

Defined in: [src/vite/plugins.ts:420](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L420)

Creates a Vite plugin for Pixi'VN integration.

**Static content loading**

When [VitePluginPixivnOptions.content](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#content), [VitePluginPixivnOptions.characters](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#characters), or
[VitePluginPixivnOptions.labels](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#labels) are provided, the matched files are executed server-side
via Vite SSR at startup, populating `RegisteredCharacters`, `RegisteredLabels`, and any other
singletons before downstream plugins (such as `vitePluginInk`) run — including during
`vite build`.

**Auto-generated type file**

When [VitePluginPixivnOptions.typeFilePath](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#typefilepath) is provided, the plugin writes a
TypeScript declaration file that augments `PixivnCharacterIds` in `@drincs/pixi-vn/characters`
and `PixivnLabelIds` in `@drincs/pixi-vn/narration` with all currently known IDs.
This narrows `CharacterIdType` and `LabelIdType` from `string` to unions of known literals,
giving compile-time safety for character lookups, `narration.call`, `narration.jump`, etc.

The file is regenerated whenever the character or label set changes (content reload or
external-label updates). It is **excluded from HMR** so regenerating it never triggers a page reload.

**Auto-generated worker file**

When [VitePluginPixivnOptions.workerFilePath](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#workerfilepath) is provided, the plugin writes a Worker
entry file wired to `handleGameWorkerMessage` from `@drincs/pixi-vn/worker` - see that option's
doc comment for what it's for (`Game.worker.register(...)`) and how to import it. Written once
(its content never changes), not regenerated on the triggers above. Add
[VitePluginPixivnOptions.autoRegisterWorker](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#autoregisterworker) to also skip the manual
`Game.worker.register(...)` call - the plugin creates and registers the worker itself.

**Auto-generated list file**

When VitePluginPixivnOptions.listFilePath is provided, the plugin writes a
TypeScript file that exports runtime `as const` arrays of all currently known IDs:
`characterIds` and `labelIds`. These arrays can be used for runtime validation
(e.g. `z.enum(characterIds)`) and are regenerated on the same triggers as the type file.

**Asset bundles / aliases**

When a PIXI.js `AssetsManifest` is registered — via [VitePluginPixivnOptions.assetsManifest](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#assetsmanifest)
or, for manifests produced by an async asset pipeline, `api.setAssetsManifest(manifest)` — the
same [VitePluginPixivnOptions.typeFilePath](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#typefilepath) also gets `export const bundleIds` /
`export const assetAliasIds` (`as const` arrays) plus `declare module` augmentations for
`PixivnBundleIds` / `PixivnAssetAliasIds` in `@drincs/pixi-vn/canvas` — narrowing that module's
`BundleIdType` / `AssetAliasIdType` from `string` to unions of known literals, exactly like
`PixivnCharacterIds` / `PixivnLabelIds` narrow `CharacterIdType` / `LabelIdType` above. The
manifest also immediately backs the `GET /__pixi-vn/assets/manifest` endpoint below.

**External label providers**

Other Vite plugins can inject label IDs via the plugin API without needing to register
them through SSR-loaded modules:

* `api.setExternalLabels(providerId, labels)` — registers (or replaces) the label list for
  the given provider and regenerates the type file.
* `api.clearExternalLabels(providerId)` — removes all labels for the given provider and
  regenerates the type file.

**Dev-server HTTP endpoints**

* `GET  /__pixi-vn/characters` — retrieve registered characters
* `POST /__pixi-vn/characters` — *(deprecated)* update from client; use the `characters` option instead
* `GET  /__pixi-vn/labels` — retrieve narration labels
* `POST /__pixi-vn/labels` — *(deprecated)* update from client; use the `labels` / `content` option instead
* `GET  /__pixi-vn/assets/manifest` — retrieve PIXI assets manifest (immediately available
  when the `assetsManifest` option is set or `api.setAssetsManifest` has been called; otherwise
  404 until a client `POST`)
* `POST /__pixi-vn/assets/manifest` — *(deprecated)* update from client; use the
  `assetsManifest` option instead
* `GET  /__pixi-vn/canvas-options` — retrieve canvas rendering options
* `POST /__pixi-vn/canvas-options` — update canvas options from client

**Plugin API** (consumed by `vitePluginInk`):

* `api.contentLoaded` — `Promise<void>` that resolves once all content modules have finished
  loading. Await this before generating JSON files.
* `api.characters` — the list of registered characters (populated after `contentLoaded`).
* `api.onReload(cb)` — register a callback that fires after every hot-content-reload.
* `api.setExternalLabels(providerId, labels)` — add/replace labels from an external provider.
* `api.clearExternalLabels(providerId)` — remove labels previously set for a provider.
* `api.setAssetsManifest(manifest)` — register/replace the assets manifest after
  plugin-creation time (e.g. once an async asset pipeline finishes); see
  [VitePluginPixivnOptions.assetsManifest](/pixi-vn/vite/interfaces/VitePluginPixivnOptions#assetsmanifest).

## Parameters [#parameters]

### options? [#options]

[`VitePluginPixivnOptions`](/pixi-vn/vite/interfaces/VitePluginPixivnOptions)

Optional plugin configuration.

## Returns [#returns]

`Plugin`

A Vite plugin.

## Example [#example]

```ts
// vite.config.ts
import { defineConfig } from "vite";
import { vitePluginPixivn } from "@drincs/pixi-vn/vite";

export default defineConfig({
  plugins: [
    vitePluginPixivn({
      content: "./src/content/index.ts",
      typeFilePath: "./src/pixi-vn.gen.d.ts",
    }),
  ],
});
```


# vite (/pixi-vn/vite)



## Interfaces [#interfaces]

* [VitePluginPixivnOptions](/pixi-vn/vite/interfaces/VitePluginPixivnOptions)

## Variables [#variables]

* [PIXIVN_DEV_API_ASSETS_MANIFEST](/pixi-vn/vite/variables/PIXIVN_DEV_API_ASSETS_MANIFEST)
* [PIXIVN_DEV_API_CANVAS_OPTIONS](/pixi-vn/vite/variables/PIXIVN_DEV_API_CANVAS_OPTIONS)
* [PIXIVN_DEV_API_CHARACTERS](/pixi-vn/vite/variables/PIXIVN_DEV_API_CHARACTERS)
* [PIXIVN_DEV_API_LABELS](/pixi-vn/vite/variables/PIXIVN_DEV_API_LABELS)

## Functions [#functions]

* [vitePluginPixivn](/pixi-vn/vite/functions/vitePluginPixivn)


# Interface: VitePluginPixivnOptions (/pixi-vn/vite/interfaces/VitePluginPixivnOptions)



Defined in: [src/vite/plugins.ts:113](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L113)

Options for [vitePluginPixivn](/pixi-vn/vite/functions/vitePluginPixivn).

## Properties [#properties]

### assetsManifest? [#assetsmanifest]

\> `optional` **assetsManifest?**: `AssetsManifestOption`

Defined in: [src/vite/plugins.ts:293](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L293)

A PIXI.js [AssetsManifest](/pixi-vn/index/interfaces/AssetsManifest) describing all asset bundles and their aliases — or a
function that resolves one, for manifests that aren't known synchronously at
plugin-creation time (e.g. one produced by an asset pipeline such as `@assetpack/core`, or
merged together from several sources in an app-owned module).

**Prefer the function form for anything backed by a generated file.** A *static*
`import manifest from "./manifest.gen.json"` in `vite.config.ts` makes Vite treat that file
as a config dependency — restarting the whole server on every change to it — which is
disastrous when the very same config's own asset pipeline rewrites that file on every
startup: an infinite restart loop. The function form sidesteps this entirely: nothing in
`vite.config.ts` itself reads or imports the file; the plugin calls your function lazily,
from inside its own plugin hooks, whenever it needs a fresh manifest.

The function receives an `ssrLoadModule`-like loader (bound to whichever context is
available — the running dev server, or a dedicated temporary server with this plugin's own
`resolve` forwarded during `vite build`) so it can load `@/`-aliased app modules the same
way `content` / `characters` / `labels` do — e.g. to import a module that merges an asset
pipeline's generated manifest with hand-written bundles. Return `undefined` if there's
nothing to register yet (e.g. the pipeline hasn't produced output on a fresh checkout).

The plugin calls this function whenever it (re)loads content — at startup, and on every
hot-reload — and, since it generally can't know which file(s) your function's own import
depends on, also on every other file change (excluding its own generated
[VitePluginPixivnOptions.typeFilePath](#typefilepath)), so a change to a manifest generated by
another plugin is picked up without any direct coupling between the two.

Either way — plain value or function — once a manifest is registered, the plugin:

* writes `export const bundleIds` and `export const assetAliasIds` — `as const` runtime
  arrays of every bundle name and every asset alias found in the manifest — to
  [VitePluginPixivnOptions.typeFilePath](#typefilepath), and augments `PixivnBundleIds` /
  `PixivnAssetAliasIds` in `@drincs/pixi-vn/canvas` (the same `declare module` pattern used
  for `PixivnCharacterIds` / `PixivnLabelIds`), narrowing `BundleIdType` / `AssetAliasIdType`
  (also exported from `@drincs/pixi-vn/canvas`) from `string` to unions of known literals.
* seeds the dev-server's `GET /__pixi-vn/assets/manifest` endpoint with this manifest
  immediately, so it is available without the browser having to `POST` it first (see
  [PIXIVN_DEV_API_ASSETS_MANIFEST](/pixi-vn/vite/variables/PIXIVN_DEV_API_ASSETS_MANIFEST)). A later `POST` (deprecated) still overrides it.

`api.setAssetsManifest(manifest)` remains available as a lower-level escape hatch for
pushing an already-computed manifest from outside this plugin entirely (e.g. from a
separate Vite plugin that doesn't need `ssrLoadModule` access).

#### Examples [#examples]

```ts
// vite.config.ts — a manifest merged from a generated file plus hand-written bundles
vitePluginPixivn({
  typeFilePath: "./src/pixi-vn.keys.gen.ts",
  assetsManifest: async (ssrLoadModule) => {
    const mod = await ssrLoadModule("/src/assets/index.ts");
    return mod.manifest;
  },
})
```

```ts
// vite.config.ts — a genuinely static manifest, known up front
vitePluginPixivn({
  assetsManifest: { bundles: [{ name: "ui", assets: { logo: "logo.png" } }] },
  typeFilePath: "./src/pixi-vn.keys.gen.ts",
})
```

***

### autoRegisterWorker? [#autoregisterworker]

\> `optional` **autoRegisterWorker?**: `boolean`

Defined in: [src/vite/plugins.ts:228](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L228)

Auto-registers the worker generated by [VitePluginPixivnOptions.workerFilePath](#workerfilepath) by
injecting a small module into `index.html` that creates it and calls
`Game.worker.register(...)` on page load - no app code required for this part, mirroring
how [VitePluginPixivnOptions.testing](#testing) auto-injects its own bridge.

Unlike `testing`, this **is** injected during `vite build` too - the worker offloads real
runtime work (`back()`, save/export diffing), not a dev-only hook, so shipping without it
would silently lose the optimization in production.

Requires [VitePluginPixivnOptions.workerFilePath](#workerfilepath) to also be set; a project that needs
more control over the worker's lifecycle (e.g. combining it with its own message types)
should keep calling `Game.worker.register(new PixivnWorker())` by hand instead and leave
this option unset - don't do both, the second registration would just replace the first.

#### Default [#default]

```ts
false
```

#### Example [#example]

```ts
// vite.config.ts — the entire worker setup, no app code needed
vitePluginPixivn({
  workerFilePath: "./src/pixi-vn.worker.gen.ts",
  autoRegisterWorker: true,
})
```

***

### characters? [#characters]

\> `optional` **characters?**: `string` | `string`\[]

Defined in: [src/vite/plugins.ts:139](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L139)

Glob / path of module(s) whose side effects register characters via
`RegisteredCharacters.add(...)`.

Use when characters are defined separately from other content.

#### Example [#example-1]

```ts
"./src/characters.ts"
```

***

### content? [#content]

\> `optional` **content?**: `string` | `string`\[]

Defined in: [src/vite/plugins.ts:129](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L129)

Glob / path of module(s) that set up all game content as side effects:
characters, labels, hashtag-command handlers, text-replace handlers, etc.

The plugin loads these files server-side (via Vite SSR) at startup so that
every downstream plugin that depends on the registered data — most notably
`vitePluginInk` for JSON compilation — has the full registry available
before it runs.  This also works during `vite build`.

Pointing to a barrel file that re-exports everything is the simplest option.
All patterns are resolved relative to Vite `root`.

#### Examples [#examples-1]

```ts
"./src/content/index.ts"
```

```ts
"./src/content/*.ts"
```

***

### labels? [#labels]

\> `optional` **labels?**: `string` | `string`\[]

Defined in: [src/vite/plugins.ts:147](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L147)

Glob / path of module(s) whose side effects register narration labels via
`RegisteredLabels.register(...)`.

#### Example [#example-2]

```ts
"./src/*.label.ts"
```

***

### testing? [#testing]

\> `optional` **testing?**: `boolean` | \{ `windowKey?`: `string`; }

Defined in: [src/vite/plugins.ts:310](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L310)

Auto-enables `Game.testing` (see the `pixi-vn-testing` skill) for as long as the dev server
keeps running, by injecting a small module into `index.html` that calls
`Game.testing.enable(...)` on page load — no app code required for this part. **Never
injected during `vite build`**, regardless of this option.

This only turns the `window` bridge on/off. Every action it exposes still needs the app's
real `StepLabelProps` (`navigate`/`t`/`toast`/etc.) to work — the app must separately call
`Game.testing.setProps(props)` wherever it already builds those props (e.g. the end of a
`useGameProps()`-style hook), unconditionally, since `setProps` is cheap and safe to call
whether or not testing happens to be enabled.

Pass `false` to opt out entirely (e.g. a shared dev server you don't want remote-controllable).

#### Union Members [#union-members]

`boolean`

***

##### Type Literal [#type-literal]

\{ `windowKey?`: `string`; }

##### windowKey? [#windowkey]

\> `optional` **windowKey?**: `string`

The `window` property the testing API is attached under.

###### Default [#default-1]

```ts
"pixiVN"
```

#### Default [#default-2]

```ts
true
```

***

### typeFilePath? [#typefilepath]

\> `optional` **typeFilePath?**: `string`

Defined in: [src/vite/plugins.ts:171](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L171)

Path to the auto-generated TypeScript file that combines compile-time type
augmentations and runtime `as const` arrays for all currently known entity IDs.

When provided, the plugin generates (or overwrites) this file:

* after all content modules have been loaded at startup,
* after every hot-reload of a watched content file,
* whenever `api.setExternalLabels` or `api.clearExternalLabels` is called.

The generated file contains:

* `declare module` augmentations for `PixivnCharacterIds` and `PixivnLabelIds`,
  narrowing `CharacterIdType` / `LabelIdType` to unions of known string literals.
* `export const characterIds` and `export const labelIds` as `as const` arrays,
  usable at runtime for validation (e.g. `z.enum(characterIds)`).

The generated file is **excluded from HMR** so that updating it never
triggers a full-page reload.

The path may be absolute or relative to Vite `root`.

#### Example [#example-3]

```ts
"./src/pixi-vn.keys.gen.ts"
```

***

### workerFilePath? [#workerfilepath]

\> `optional` **workerFilePath?**: `string`

Defined in: [src/vite/plugins.ts:201](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/plugins.ts#L201)

Path to an auto-generated Worker entry file that hands every message it receives to
`handleGameWorkerMessage` from `@drincs/pixi-vn/worker` — the file a project needs to make
`Game.worker.register(...)` (see that function's doc comment) actually do something,
without having to hand-write and maintain that file itself.

Written once, when the plugin's config resolves (its content never changes, so unlike
[typeFilePath](#typefilepath) there's nothing to regenerate on content reload). Wire it up with
Vite's own `?worker` import:

```ts
// vite.config.ts
vitePluginPixivn({ workerFilePath: "./src/pixi-vn.worker.gen.ts" })

// wherever the app calls Game.init(...)
import { Game } from "@drincs/pixi-vn";
import PixivnWorker from "./pixi-vn.worker.gen?worker";
Game.worker.register(new PixivnWorker());
```

Purely a convenience: a project that wants a different worker setup (e.g. combining this
with its own message types on the same worker) can just write the file by hand instead and
skip this option entirely - `Game.worker.register` doesn't care which side created the file.

The path may be absolute or relative to Vite `root`.

#### Example [#example-4]

```ts
"./src/pixi-vn.worker.gen.ts"
```


# Variable: PIXIVN_DEV_API_ASSETS_MANIFEST (/pixi-vn/vite/variables/PIXIVN_DEV_API_ASSETS_MANIFEST)



\> `const` **PIXIVN_DEV_API_ASSETS_MANIFEST**: `"/__pixi-vn/assets/manifest"` = `"/__pixi-vn/assets/manifest"`

Defined in: [src/vite/costants.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/costants.ts#L8)

## Const [#const]

API endpoint for assets manifest - GET to retrieve, POST to update


# Variable: PIXIVN_DEV_API_CANVAS_OPTIONS (/pixi-vn/vite/variables/PIXIVN_DEV_API_CANVAS_OPTIONS)



\> `const` **PIXIVN_DEV_API_CANVAS_OPTIONS**: `"/__pixi-vn/canvas-options"` = `"/__pixi-vn/canvas-options"`

Defined in: [src/vite/costants.ts:11](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/costants.ts#L11)

## Const [#const]

API endpoint for canvas options - GET to retrieve, POST to update


# Variable: PIXIVN_DEV_API_CHARACTERS (/pixi-vn/vite/variables/PIXIVN_DEV_API_CHARACTERS)



\> `const` **PIXIVN_DEV_API_CHARACTERS**: `"/__pixi-vn/characters"` = `"/__pixi-vn/characters"`

Defined in: [src/vite/costants.ts:2](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/costants.ts#L2)

## Const [#const]

API endpoint for characters data - GET to retrieve, POST to update


# Variable: PIXIVN_DEV_API_LABELS (/pixi-vn/vite/variables/PIXIVN_DEV_API_LABELS)



\> `const` **PIXIVN_DEV_API_LABELS**: `"/__pixi-vn/labels"` = `"/__pixi-vn/labels"`

Defined in: [src/vite/costants.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/vite/costants.ts#L5)

## Const [#const]

API endpoint for narration labels - GET to retrieve, POST to update


# Class: JsonUnifier (/pixi-vn-json/core/classes/JsonUnifier)



Defined in: [src/core/JsonUnifier.ts:39](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L39)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new JsonUnifier**(): `JsonUnifier`

#### Returns [#returns]

`JsonUnifier`

## Accessors [#accessors]

### animateOperation [#animateoperation]

#### Get Signature [#get-signature]

\> **get** `static` **animateOperation**(): (`operation`) => `void`

Defined in: [src/core/JsonUnifier.ts:306](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L306)

Registered handler for keyframe animation operations.

##### Returns [#returns-1]

(`operation`) => `void`

***

### canvasElementOperation [#canvaselementoperation]

#### Get Signature [#get-signature-1]

\> **get** `static` **canvasElementOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:235](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L235)

Registered handler for generic canvas-element edit/remove operations.

##### Returns [#returns-2]

(`operation`) => `Promise`\<`void`>

***

### canvasOperation [#canvasoperation]

#### Get Signature [#get-signature-2]

\> **get** `static` **canvasOperation**(): (`operation`) => `void`

Defined in: [src/core/JsonUnifier.ts:319](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L319)

Registered handler for generic canvas-wide operations (e.g. clear).

##### Returns [#returns-3]

(`operation`) => `void`

***

### effectOperation [#effectoperation]

#### Get Signature [#get-signature-3]

\> **get** `static` **effectOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:293](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L293)

Registered handler for canvas visual effects (e.g. shake).

##### Returns [#returns-4]

(`operation`) => `Promise`\<`void`>

***

### getConditionalStep [#getconditionalstep]

#### Get Signature [#get-signature-4]

\> **get** `static` **getConditionalStep**(): (`originalStep`, `props?`) => [`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)

Defined in: [src/core/JsonUnifier.ts:358](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L358)

Registered handler that resolves a label step's `conditionalStep` field.

##### Returns [#returns-5]

(`originalStep`, `props?`) => [`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)

***

### getLogichValue [#getlogichvalue]

#### Get Signature [#get-signature-5]

\> **get** `static` **getLogichValue**(): \<`T`>(`value`, `props?`) => `T` | `undefined`

Defined in: [src/core/JsonUnifier.ts:342](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L342)

Registered handler that evaluates a JSON logic expression to a plain value.

##### Returns [#returns-6]

\<`T`>(`value`, `props?`) => `T` | `undefined`

***

### imageContainerOperation [#imagecontaineroperation]

#### Get Signature [#get-signature-6]

\> **get** `static` **imageContainerOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:201](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L201)

##### Returns [#returns-7]

(`operation`) => `Promise`\<`void`>

***

### imageOperation [#imageoperation]

#### Get Signature [#get-signature-7]

\> **get** `static` **imageOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:165](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L165)

Registered handler for ImageSprite show/edit/remove operations.

##### Returns [#returns-8]

(`operation`) => `Promise`\<`void`>

***

### loadAssets [#loadassets]

#### Get Signature [#get-signature-8]

\> **get** `static` **loadAssets**(): (`origin`) => `void` | `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:137](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L137)

Registered handler for loading/lazy-loading assets.

##### Returns [#returns-9]

(`origin`) => `void` | `Promise`\<`void`>

***

### narrationOperation [#narrationoperation]

#### Get Signature [#get-signature-9]

\> **get** `static` **narrationOperation**(): (`operation`) => `void`

Defined in: [src/core/JsonUnifier.ts:280](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L280)

Registered handler for narration operations (input requests, dialogue resets).

##### Returns [#returns-10]

(`operation`) => `void`

***

### setInitialStorageValue [#setinitialstoragevalue]

#### Get Signature [#get-signature-10]

\> **get** `static` **setInitialStorageValue**(): (`value`, `props?`) => `void`

Defined in: [src/core/JsonUnifier.ts:267](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L267)

Registered handler for setting a default (initial) storage value at import time.

##### Returns [#returns-11]

(`value`, `props?`) => `void`

***

### setStorageValue [#setstoragevalue]

#### Get Signature [#get-signature-11]

\> **get** `static` **setStorageValue**(): (`value`, `props?`) => `void`

Defined in: [src/core/JsonUnifier.ts:251](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L251)

Registered handler for setting a storage value during label execution.

##### Returns [#returns-12]

(`value`, `props?`) => `void`

***

### soundOperation [#soundoperation]

#### Get Signature [#get-signature-12]

\> **get** `static` **soundOperation**(): (`operation`) => `void`

Defined in: [src/core/JsonUnifier.ts:150](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L150)

Registered handler for sound play/stop/pause/resume/edit operations.

##### Returns [#returns-13]

(`operation`) => `void`

***

### textOperation [#textoperation]

#### Get Signature [#get-signature-13]

\> **get** `static` **textOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:216](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L216)

Registered handler for Text show/edit/remove operations.

##### Returns [#returns-14]

(`operation`) => `Promise`\<`void`>

***

### videoOperation [#videooperation]

#### Get Signature [#get-signature-14]

\> **get** `static` **videoOperation**(): (`operation`) => `Promise`\<`void`>

Defined in: [src/core/JsonUnifier.ts:184](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L184)

Registered handler for VideoSprite show/edit/remove/pause/resume operations.

##### Returns [#returns-15]

(`operation`) => `Promise`\<`void`>

## Methods [#methods]

### init() [#init]

\> `static` **init**(`options`): `void`

Defined in: [src/core/JsonUnifier.ts:47](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/core/JsonUnifier.ts#L47)

Registers the operation handlers that pixi-vn-json will delegate to at runtime.
Call this once at application startup (e.g. via [init](#init)) before importing any labels.

All parameters are optional except `setInitialStorageValue`, which is required because
it must be available for initial-operation processing during label import.

#### Parameters [#parameters]

##### options [#options]

###### animateOperation? [#animateoperation-1]

(`operation`) => `void`

###### canvasElementOperation? [#canvaselementoperation-1]

(`operation`) => `Promise`\<`void`>

###### canvasOperation? [#canvasoperation-1]

(`operation`) => `void`

###### effectOperation? [#effectoperation-1]

(`operation`) => `Promise`\<`void`>

###### getConditionalStep? [#getconditionalstep-1]

(`originalStep`, `props?`) => [`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)

###### getLogichValue? [#getlogichvalue-1]

\<`T`>(`value`, `props?`) => `T` | `undefined`

###### imageContainerOperation? [#imagecontaineroperation-1]

(`operation`) => `Promise`\<`void`>

###### imageOperation? [#imageoperation-1]

(`operation`) => `Promise`\<`void`>

###### loadAssets? [#loadassets-1]

(`origin`) => `void` | `Promise`\<`void`>

###### narrationOperation? [#narrationoperation-1]

(`operation`) => `void`

###### setInitialStorageValue [#setinitialstoragevalue-1]

(`value`, `props?`) => `void`

###### setStorageValue? [#setstoragevalue-1]

(`value`, `props?`) => `void`

###### soundOperation? [#soundoperation-1]

(`operation`) => `void`

###### textOperation? [#textoperation-1]

(`operation`) => `Promise`\<`void`>

###### videoOperation? [#videooperation-1]

(`operation`) => `Promise`\<`void`>

#### Returns [#returns-16]

`void`


# core (/pixi-vn-json/core)



## Classes [#classes]

* [JsonUnifier](/pixi-vn-json/core/classes/JsonUnifier)


# docs-entry (/pixi-vn-json/docs-entry)



## Interfaces [#interfaces]

* [ImageContainerOptions](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions)
* [ImageSprite](/pixi-vn-json/docs-entry/interfaces/ImageSprite)
* [ImageSpriteOptions](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions)
* [MediaInterface](/pixi-vn-json/docs-entry/interfaces/MediaInterface)
* [MoveInOutProps](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps)
* [PushInOutProps](/pixi-vn-json/docs-entry/interfaces/PushInOutProps)
* [ShowWithDissolveTransitionProps](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps)
* [ShowWithFadeTransitionProps](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps)
* [SoundPlayOptionsWithChannel](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel)
* [TextOptions](/pixi-vn-json/docs-entry/interfaces/TextOptions)
* [ZoomInOutProps](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps)

## Type Aliases [#type-aliases]

* [AnimationOptions](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)
* [SequenceOptions](/pixi-vn-json/docs-entry/type-aliases/SequenceOptions)


# Interface: ImageContainerOptions<C> (/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:948

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `ContainerOptions`\<`C`>

## Extended by [#extended-by]

* [`PixiVNJsonCanvasImageContainerShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageContainerShowProps)

## Type Parameters [#type-parameters]

### C [#c]

`C` *extends* `ContainerChild$1` = `ContainerChild$1`

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`ContainerOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`ContainerOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`ContainerOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`ContainerOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`ContainerOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`ContainerOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`ContainerOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`ContainerOptions.align`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`ContainerOptions.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:919

#### Inherited from [#inherited-from-9]

`ContainerOptions.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`ContainerOptions.angle`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-11]

`ContainerOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-12]

`ContainerOptions.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-13]

`ContainerOptions.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `C`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-14]

`ContainerOptions.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-15]

`ContainerOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-16]

`ContainerOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-17]

`ContainerOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-18]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-19]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-20]

`ContainerOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-21]

`ContainerOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-22]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

`ContainerOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

`ContainerOptions.label`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`ContainerOptions.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-28]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-49]

`ContainerOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-61]

`ContainerOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-62]

`ContainerOptions.parent`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-63]

`ContainerOptions.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

`ContainerOptions.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

`ContainerOptions.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-66]

`ContainerOptions.pivot`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-67]

`ContainerOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-68]

`ContainerOptions.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-69]

`ContainerOptions.rotation`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-70]

`ContainerOptions.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-71]

`ContainerOptions.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-72]

`ContainerOptions.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-73]

`ContainerOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-74]

`ContainerOptions.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-75]

`ContainerOptions.tabIndex`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-76]

`ContainerOptions.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-77]

`ContainerOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-78]

`ContainerOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-79]

`ContainerOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-80]

`ContainerOptions.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-81]

`ContainerOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-82]

`ContainerOptions.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-83]

`ContainerOptions.zIndex`


# Interface: ImageSprite<Memory> (/pixi-vn-json/docs-entry/interfaces/ImageSprite)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1084

This class is a extension of the Sprite class, it has the same properties and methods,
but it has some features that make texture management easier.
You need to use [load](#load) to show the image in the canvas.
This class is used for functions like addImage and showWithDissolve.

## Examples [#examples]

```ts
let alien = new ImageSprite({
    anchor: { x: 0.5, y: 0.5 },
    x: 100,
    y: 100,
}, 'https://pixijs.com/assets/eggHead.png')
await alien.load()
canvas.add("alien", alien)
```

```ts
let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
alien.anchor.set(0.5);
alien.x = 100
alien.y = 100
await alien.load()
```

## Extends [#extends]

* `Sprite`\<`Memory`>

## Type Parameters [#type-parameters]

### Memory [#memory]

`Memory` *extends* `ImageSpriteMemory` = `ImageSpriteMemory`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

`Sprite.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

`Sprite.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

`Sprite.__devtoolLocked`

***

### \_anchor [#_anchor]

\> `readonly` **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:155

**`Internal`**

#### Inherited from [#inherited-from-3]

`Sprite._anchor`

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

#### Inherited from [#inherited-from-4]

`Sprite._bounds`

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

#### Inherited from [#inherited-from-5]

`Sprite._boundsDirty`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-6]

`Sprite._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-7]

`Sprite._cy`

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

#### Inherited from [#inherited-from-8]

`Sprite._gcData`

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

#### Inherited from [#inherited-from-9]

`Sprite._gcLastUsed`

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

#### Inherited from [#inherited-from-10]

`Sprite._gpuData`

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

#### Inherited from [#inherited-from-11]

`Sprite._lastUsed`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-12]

`Sprite._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-13]

`Sprite._position`

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

#### Inherited from [#inherited-from-14]

`Sprite._roundPixels`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-15]

`Sprite._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-16]

`Sprite._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-17]

`Sprite._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-18]

`Sprite._sy`

***

### \_texture [#_texture]

\> **\_texture**: `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:157

**`Internal`**

#### Inherited from [#inherited-from-19]

`Sprite._texture`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-20]

`Sprite._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-21]

`Sprite.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-22]

`Sprite.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-23]

`Sprite.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-24]

`Sprite.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-25]

`Sprite.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-26]

`Sprite.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-27]

`Sprite.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

#### Inherited from [#inherited-from-28]

`Sprite.allowChildren`

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-29]

`Sprite.autoGarbageCollect`

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:153

**`Internal`**

#### Inherited from [#inherited-from-30]

`Sprite.batched`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-7]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-31]

`Sprite.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-32]

`Sprite.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns]

`void`

#### Example [#example-8]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* Container#updateCacheTexture For updating cached content
* [Container#isCachedAsTexture](#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-33]

`Sprite.cacheAsTexture`

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

#### Inherited from [#inherited-from-34]

`Sprite.canBundle`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-9]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-35]

`Sprite.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-10]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-36]

`Sprite.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-11]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-37]

`Sprite.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-12]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-38]

`Sprite.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-13]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-39]

`Sprite.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-40]

`Sprite.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-14]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

Container#destroy For destroying objects

#### Inherited from [#inherited-from-41]

`Sprite.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-42]

`Sprite.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-15]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-43]

`Sprite.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-16]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* Container#filters For applying filters
* Rectangle For area definition

#### Inherited from [#inherited-from-44]

`Sprite.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-45]

`Sprite.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-46]

`Sprite.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-47]

`Sprite.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-48]

`Sprite.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-49]

`Sprite.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-50]

`Sprite.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-17]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-51]

`Sprite.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](#eventmode)

#### Example [#example-18]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-52]

`Sprite.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-19]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-53]

`Sprite.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-20]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* Container#cacheAsTexture For enabling caching
* Container#updateCacheTexture For updating cache

#### Inherited from [#inherited-from-54]

`Sprite.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-2]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-21]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-55]

`Sprite.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-56]

`Sprite.label`

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-57]

`Sprite.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-58]

`Sprite.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-59]

`Sprite.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-60]

`Sprite.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-61]

`Sprite.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-22]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](#worldtransform) For global transform
* [Container#groupTransform](#grouptransform) For render group transform

#### Inherited from [#inherited-from-62]

`Sprite.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-23]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-63]

`Sprite.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-64]

`Sprite.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-65]

`Sprite.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: `OnEventsHandlers`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1004

ListenerExtension

#### Inherited from [#inherited-from-66]

`Sprite.onEventsHandlers`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-67]

`Sprite.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-68]

`Sprite.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-69]

`Sprite.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-70]

`Sprite.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-71]

`Sprite.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-72]

`Sprite.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-73]

`Sprite.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-74]

`Sprite.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-75]

`Sprite.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-76]

`Sprite.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-77]

`Sprite.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-78]

`Sprite.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-79]

`Sprite.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-80]

`Sprite.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-81]

`Sprite.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-82]

`Sprite.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-83]

`Sprite.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-84]

`Sprite.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-85]

`Sprite.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-86]

`Sprite.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-87]

`Sprite.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-46]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-88]

`Sprite.onRender`

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-89]

`Sprite.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-90]

`Sprite.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-91]

`Sprite.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-92]

`Sprite.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-93]

`Sprite.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-94]

`Sprite.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-95]

`Sprite.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-96]

`Sprite.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-97]

`Sprite.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-98]

`Sprite.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-99]

`Sprite.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-58]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-100]

`Sprite.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-101]

`Sprite.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1087

#### Overrides [#overrides]

`Sprite.pixivnId`

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-102]

`Sprite.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:151

**`Internal`**

#### Inherited from [#inherited-from-103]

`Sprite.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-59]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-104]

`Sprite.sortableChildren`

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-3]

`void`

#### Example [#example-60]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](#sortablechildren) For enabling automatic sorting
* [Container#zIndex](#zindex) For setting child order

#### Inherited from [#inherited-from-105]

`Sprite.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-106]

`Sprite.sortDirty`

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-61]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-107]

`Sprite.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-108]

`Sprite.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-4]

`void`

#### Example [#example-62]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-109]

`Sprite.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-110]

`Sprite.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-63]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-111]

`Sprite.zIndex`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1021

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-5]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1020

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-1]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-6]

`void`

#### Inherited from [#inherited-from-112]

`Sprite.align`

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-64]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* Container#visible For toggling visibility
* Container#renderable For render control

##### Returns [#returns-7]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-2]

###### value [#value-1]

`number`

##### Returns [#returns-8]

`void`

#### Inherited from [#inherited-from-113]

`Sprite.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:256

The anchor sets the origin point of the sprite. The default value is taken from the Texture
and passed to the constructor.

* The default is `(0,0)`, this means the sprite's origin is the top left.
* Setting the anchor to `(0.5,0.5)` means the sprite's origin is centered.
* Setting the anchor to `(1,1)` would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-65]

```ts
// Center the anchor point
sprite.anchor = 0.5; // Sets both x and y to 0.5
sprite.position.set(400, 300); // Sprite will be centered at this position

// Set specific x/y anchor points
sprite.anchor = {
    x: 1, // Right edge
    y: 0  // Top edge
};

// Using individual coordinates
sprite.anchor.set(0.5, 1); // Center-bottom

// For rotation around center
sprite.anchor.set(0.5);
sprite.rotation = Math.PI / 4; // 45 degrees around center

// For scaling from center
sprite.anchor.set(0.5);
sprite.scale.set(2); // Scales from center point
```

##### Returns [#returns-9]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:257

##### Parameters [#parameters-3]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-114]

`Sprite.anchor`

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-11]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-4]

###### value [#value-3]

`number`

##### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-115]

`Sprite.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* Container#alpha For transparency
* Container#tint For color adjustments

##### Returns [#returns-13]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-5]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-14]

`void`

#### Inherited from [#inherited-from-116]

`Sprite.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-68]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-15]

`Bounds`

The rectangular bounds of the view

#### Inherited from [#inherited-from-117]

`Sprite.bounds`

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-16]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-6]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-17]

`void`

#### Inherited from [#inherited-from-118]

`Sprite.filters`

***

### haveEmptyTexture [#haveemptytexture]

#### Get Signature [#get-signature-7]

\> **get** **haveEmptyTexture**(): `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1109

Check if the texture is empty.

##### Returns [#returns-18]

`boolean`

A boolean that is true if the texture is empty.

***

### height [#height]

#### Get Signature [#get-signature-8]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:300

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-71]

```ts
// Set height directly
sprite.height = 150;
console.log(sprite.scale.y); // Scale adjusted to match height

// Set height while preserving aspect ratio
const ratio = sprite.width / sprite.height;
sprite.height = 200;
sprite.width = 200 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.height = sprite.texture.orig.height;
```

##### Returns [#returns-19]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:301

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-72]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-7]

###### value [#value-6]

`number`

##### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-119]

`Sprite.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-9]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-21]

`boolean`

#### Inherited from [#inherited-from-120]

`Sprite.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-10]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-22]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-8]

###### value [#value-7]

`boolean`

##### Returns [#returns-23]

`void`

#### Inherited from [#inherited-from-121]

`Sprite.isRenderGroup`

***

### loadIsStarted [#loadisstarted]

#### Get Signature [#get-signature-11]

\> **get** **loadIsStarted**(): `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1097

##### Returns [#returns-24]

`boolean`

***

### memory [#memory-1]

#### Get Signature [#get-signature-12]

\> **get** **memory**(): `ImageSpriteMemory`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1093

##### Returns [#returns-25]

`ImageSpriteMemory`

#### Overrides [#overrides-1]

`Sprite.memory`

***

### origin [#origin]

#### Get Signature [#get-signature-13]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-73]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-26]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-9]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-27]

`void`

#### Inherited from [#inherited-from-122]

`Sprite.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-14]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1028

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-28]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1027

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-10]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-29]

`void`

#### Inherited from [#inherited-from-123]

`Sprite.percentagePosition`

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-15]

\> **get** **percentageX**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1029

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-30]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1030

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### \_value [#_value]

`number`

##### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-124]

`Sprite.percentageX`

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-16]

\> **get** **percentageY**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1031

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-32]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1032

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value-1]

`number`

##### Returns [#returns-33]

`void`

#### Inherited from [#inherited-from-125]

`Sprite.percentageY`

***

### pivot [#pivot]

#### Get Signature [#get-signature-17]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-74]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-34]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-13]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-35]

`void`

#### Inherited from [#inherited-from-126]

`Sprite.pivot`

***

### position [#position]

#### Get Signature [#get-signature-18]

\> **get** **position**(): `ObservablePoint`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1045

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-75]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-36]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1046

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-14]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-37]

`void`

#### Inherited from [#inherited-from-127]

`Sprite.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-19]

\> **get** **positionInfo**(): `object`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1034

##### Returns [#returns-38]

`object`

###### type [#type]

\> **type**: `"align"` | `"pixel"` | `"percentage"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1039

##### Parameters [#parameters-15]

###### value [#value-12]

###### type? [#type-1]

`"align"` | `"pixel"` | `"percentage"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-39]

`void`

#### Inherited from [#inherited-from-128]

`Sprite.positionInfo`

***

### positionType [#positiontype]

#### Get Signature [#get-signature-20]

\> **get** **positionType**(): `"align"` | `"pixel"` | `"percentage"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1033

##### Returns [#returns-40]

`"align"` | `"pixel"` | `"percentage"`

#### Inherited from [#inherited-from-129]

`Sprite.positionType`

***

### renderable [#renderable]

#### Get Signature [#get-signature-21]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-77]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* Container#visible For skipping transform updates
* Container#alpha For transparency

##### Returns [#returns-41]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-16]

###### value [#value-13]

`boolean`

##### Returns [#returns-42]

`void`

#### Inherited from [#inherited-from-130]

`Sprite.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-22]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-78]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-43]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-17]

###### value [#value-14]

`number`

##### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-131]

`Sprite.rotation`

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-23]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-79]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-45]

`boolean`

#### Set Signature [#set-signature-17]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-18]

###### value [#value-15]

`boolean`

##### Returns [#returns-46]

`void`

#### Inherited from [#inherited-from-132]

`Sprite.roundPixels`

***

### scale [#scale]

#### Get Signature [#get-signature-24]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-80]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-47]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-19]

###### value [#value-16]

`string` | `number` | `PointData`

##### Returns [#returns-48]

`void`

#### Inherited from [#inherited-from-133]

`Sprite.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-25]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-81]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-49]

`ObservablePoint`

#### Set Signature [#set-signature-19]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-20]

###### value [#value-17]

`PointData`

##### Returns [#returns-50]

`void`

#### Inherited from [#inherited-from-134]

`Sprite.skew`

***

### texture [#texture]

#### Get Signature [#get-signature-26]

\> **get** **texture**(): `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1104

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-82]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-20]

* Texture For texture creation and management
* Assets For asset loading

##### Returns [#returns-51]

`Texture`\<`TextureSource`\<`any`>>

#### Set Signature [#set-signature-20]

\> **set** **texture**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1103

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-83]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-21]

* Texture For texture creation and management
* Assets For asset loading

##### Parameters [#parameters-21]

###### value [#value-18]

`Texture`\<`TextureSource`\<`any`>>

##### Returns [#returns-52]

`void`

#### Overrides [#overrides-2]

`Sprite.texture`

***

### textureAlias [#texturealias]

#### Get Signature [#get-signature-27]

\> **get** `protected` **textureAlias**(): `string`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1086

##### Returns [#returns-53]

`string`

***

### tint [#tint]

#### Get Signature [#get-signature-28]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-84]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-22]

* Container#alpha For transparency
* Container#visible For visibility control

##### Returns [#returns-54]

`number`

#### Set Signature [#set-signature-21]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-22]

###### value [#value-19]

`ColorSource`

##### Returns [#returns-55]

`void`

#### Inherited from [#inherited-from-135]

`Sprite.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-29]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-85]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-23]

* Container#renderable For render-only control
* Container#alpha For transparency

##### Returns [#returns-56]

`boolean`

#### Set Signature [#set-signature-22]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-23]

###### value [#value-20]

`boolean`

##### Returns [#returns-57]

`void`

#### Inherited from [#inherited-from-136]

`Sprite.visible`

***

### visualBounds [#visualbounds]

#### Get Signature [#get-signature-30]

\> **get** **visualBounds**(): `BoundsData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:205

The bounds of the sprite, taking into account the texture's trim area.

##### Example [#example-86]

````ts
const texture = new Texture({
    source: new TextureSource({ width: 300, height: 300 }),
    frame: new Rectangle(196, 66, 58, 56),
    trim: new Rectangle(4, 4, 58, 56),
    orig: new Rectangle(0, 0, 64, 64),
    rotate: 2,
});
const sprite = new Sprite(texture);
const visualBounds = sprite.visualBounds;
// console.log(visualBounds); // { minX: -4, maxX: 62, minY: -4, maxY: 60 }

##### Returns

`BoundsData`

#### Inherited from

`Sprite.visualBounds`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: node\_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:278

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example

```ts
// Set width directly
sprite.width = 200;
console.log(sprite.scale.x); // Scale adjusted to match width

// Set width while preserving aspect ratio
const ratio = sprite.height / sprite.width;
sprite.width = 300;
sprite.height = 300 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.width = sprite.texture.orig.width;
````

##### Returns [#returns-58]

`number`

#### Set Signature [#set-signature-23]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:279

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-24]

###### value [#value-21]

`number`

##### Returns [#returns-59]

`void`

#### Inherited from [#inherited-from-137]

`Sprite.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-31]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-24]

[Container#localTransform](#localtransform) For local space transform

##### Returns [#returns-60]

`Matrix`

#### Inherited from [#inherited-from-138]

`Sprite.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-32]

> **get** **x**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1047

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-61]

`number`

#### Set Signature [#set-signature-24]

> **set** **x**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1048

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-25]

###### value [#value-22]

`number`

##### Returns [#returns-62]

`void`

#### Inherited from [#inherited-from-139]

`Sprite.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-33]

> **get** **xAlign**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1023

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-63]

`number`

#### Set Signature [#set-signature-25]

> **set** **xAlign**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1022

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-26]

###### value [#value-23]

`number`

##### Returns [#returns-64]

`void`

#### Inherited from [#inherited-from-140]

`Sprite.xAlign`

***

### y [#y-2]

#### Get Signature [#get-signature-34]

> **get** **y**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1049

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-65]

`number`

#### Set Signature [#set-signature-26]

> **set** **y**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1050

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-27]

###### value [#value-24]

`number`

##### Returns [#returns-66]

`void`

#### Inherited from [#inherited-from-141]

`Sprite.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-35]

> **get** **yAlign**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1025

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-67]

`number`

#### Set Signature [#set-signature-27]

> **set** **yAlign**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1024

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-28]

###### value [#value-25]

`number`

##### Returns [#returns-68]

`void`

#### Inherited from [#inherited-from-142]

`Sprite.yAlign`

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-29]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-69]

`void`

#### Inherited from [#inherited-from-143]

`Sprite._getGlobalBoundsRecursive`

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-30]

##### now [#now]

`number`

#### Returns [#returns-70]

`void`

#### Inherited from [#inherited-from-144]

`Sprite._onTouch`

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-31]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-71]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-25]

* Container#removeChild For removing children
* Container#addChildAt For adding at specific index

#### Inherited from [#inherited-from-145]

`Sprite.addChild`

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-32]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-72]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws]

If index is out of bounds

#### See [#see-26]

* Container#addChild For adding to the end
* Container#setChildIndex For moving existing children

#### Inherited from [#inherited-from-146]

`Sprite.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-33]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-73]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-147]

`Sprite.addEventListener`

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-34]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-1]

`AddListenerOptions`

##### Returns [#returns-74]

`void`

##### Inherited from [#inherited-from-148]

`Sprite.addEventListener`

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-35]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-75]

`this`

#### Inherited from [#inherited-from-149]

`Sprite.addListener`

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-36]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-76]

`void`

#### Inherited from [#inherited-from-150]

`Sprite.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-37]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-77]

`void`

#### Inherited from [#inherited-from-151]

`Sprite.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-38]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-78]

`void`

#### Inherited from [#inherited-from-152]

`Sprite.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-39]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-79]

`boolean`

True if the point is within the view's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-27]

* ViewContainer#bounds For the bounds used in hit testing
* [Container#toLocal](#tolocal) For converting global coordinates to local

#### Inherited from [#inherited-from-153]

`Sprite.containsPoint`

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-40]

##### options? [#options-2]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-80]

`void`

#### Example [#example-97]

```ts
sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });
```

#### Inherited from [#inherited-from-154]

`Sprite.destroy`

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-81]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-155]

`Sprite.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-41]

##### e [#e]

`FederatedEvent`

The event to dispatch.

#### Returns [#returns-82]

`boolean`

Whether the FederatedEvent.preventDefault preventDefault() method was not invoked.

#### Example [#example-98]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-156]

`Sprite.dispatchEvent`

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-42]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-83]

`boolean`

#### Inherited from [#inherited-from-157]

`Sprite.emit`

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-84]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-158]

`Sprite.enableRenderGroup`

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-85]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-159]

`Sprite.eventNames`

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-43]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-86]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-99]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-28]

* [Container#getLocalBounds](#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-160]

`Sprite.getBounds`

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-44]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-87]

`U`

The child at the given index

#### Example [#example-100]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-29]

* Container#children For direct array access
* Container#getChildByLabel For name-based lookup

#### Inherited from [#inherited-from-161]

`Sprite.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-45]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-88]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-101]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-30]

* Container#getChildrenByLabel For finding all matches
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-162]

`Sprite.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-46]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-89]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-31]

Container#getChildByLabel

#### Inherited from [#inherited-from-163]

`Sprite.getChildByName`

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-47]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-90]

`number`

The index position of the child container

#### Example [#example-102]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-2]

If child is not in this container

#### See [#see-32]

* Container#setChildIndex For changing index
* Container#children For direct array access

#### Inherited from [#inherited-from-164]

`Sprite.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-48]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-91]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-103]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-33]

* Container#getChildByLabel For finding first match
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-165]

`Sprite.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-49]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-92]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-166]

`Sprite.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-50]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-93]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-104]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-167]

`Sprite.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-51]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-94]

`Point`

The updated point

#### Example [#example-105]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-34]

* [Container#toGlobal](#toglobal) For converting specific points
* [Container#toLocal](#tolocal) For converting to local space

#### Inherited from [#inherited-from-168]

`Sprite.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-52]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-95]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-169]

`Sprite.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-53]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-96]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-170]

`Sprite.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-97]

`Bounds`

The bounding area

#### Example [#example-108]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-35]

* [Container#getBounds](#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-171]

`Sprite.getLocalBounds`

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:322

Retrieves the size of the Sprite as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-54]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-98]

`Size`

The size of the Sprite

#### Example [#example-109]

```ts
// Basic size retrieval
const sprite = new Sprite(Texture.from('sprite.png'));
const size = sprite.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
sprite.getSize(reuseSize);
```

#### See [#see-36]

* Sprite#width For getting just the width
* Sprite#height For getting just the height
* Sprite#setSize For setting both width and height

#### Inherited from [#inherited-from-172]

`Sprite.getSize`

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-55]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-99]

`number`

#### Inherited from [#inherited-from-173]

`Sprite.listenerCount`

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-56]

##### event [#event-3]

`T`

#### Returns [#returns-100]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-174]

`Sprite.listeners`

***

### load() [#load]

> **load**(): `Promise`\<`void`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1102

Load the image from the link and set the texture of the sprite.

#### Returns [#returns-101]

`Promise`\<`void`>

A promise that resolves when the image is loaded.

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-57]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-102]

`this`

#### Inherited from [#inherited-from-175]

`Sprite.off`

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1005

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-58]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-103]

`this`

#### Inherited from [#inherited-from-176]

`Sprite.on`

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-59]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-104]

`this`

#### Inherited from [#inherited-from-177]

`Sprite.once`

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1044

#### Returns [#returns-105]

`void`

#### Inherited from [#inherited-from-178]

`Sprite.reloadPosition`

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-60]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-106]

`this`

#### Inherited from [#inherited-from-179]

`Sprite.removeAllListeners`

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-61]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-107]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-37]

* Container#addChild For adding children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-180]

`Sprite.removeChild`

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-62]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-108]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-3]

If index is out of bounds

#### See [#see-38]

* Container#removeChild For removing specific children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-181]

`Sprite.removeChildAt`

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-63]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-109]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-4]

If begin/end indexes are invalid

#### See [#see-39]

* Container#addChild For adding children
* Container#removeChild For removing specific children

#### Inherited from [#inherited-from-182]

`Sprite.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-64]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-3]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-110]

`void`

##### Inherited from [#inherited-from-183]

`Sprite.removeEventListener`

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-65]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-4]

`RemoveListenerOptions`

##### Returns [#returns-111]

`void`

##### Inherited from [#inherited-from-184]

`Sprite.removeEventListener`

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-112]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-40]

* Container#addChild For adding to a new parent
* Container#removeChild For parent removing children

#### Inherited from [#inherited-from-185]

`Sprite.removeFromParent`

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-66]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-113]

`this`

#### Inherited from [#inherited-from-186]

`Sprite.removeListener`

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-67]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-114]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-41]

* Container#reparentChildAt For index-specific reparenting
* Container#addChild For simple parenting

#### Inherited from [#inherited-from-187]

`Sprite.reparentChild`

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-68]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-115]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-5]

If index is out of bounds

#### See [#see-42]

* Container#reparentChild For appending reparented children
* Container#addChildAt For simple indexed parenting

#### Inherited from [#inherited-from-188]

`Sprite.reparentChildAt`

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-69]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-116]

`void`

#### Inherited from [#inherited-from-189]

`Sprite.replaceChild`

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-70]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-117]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-6]

If index is out of bounds

#### Throws [#throws-7]

If child is not in container

#### See [#see-43]

* Container#getChildIndex For getting current index
* Container#swapChildren For swapping positions

#### Inherited from [#inherited-from-190]

`Sprite.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-71]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-118]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-44]

* Container#updateTransform For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-191]

`Sprite.setFromMatrix`

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-72]

##### options [#options-5]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-119]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-45]

* [Container#mask](#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-192]

`Sprite.setMask`

***

### setMemory() [#setmemory]

> **setMemory**(`memory`): `Promise`\<`void`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1094

#### Parameters [#parameters-73]

##### memory [#memory-2]

`Memory` | `SpriteMemory`

#### Returns [#returns-120]

`Promise`\<`void`>

#### Overrides [#overrides-3]

`Sprite.setMemory`

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:353

Sets the size of the Sprite to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-74]

##### value [#value-26]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-121]

`void`

#### Example [#example-119]

```ts
// Basic size setting
const sprite = new Sprite(Texture.from('sprite.png'));
sprite.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
sprite.setSize(100); // Sets both width and height to 100

// Set size with object
sprite.setSize({
    width: 200,
    height: 300
});

// Reset to texture size
sprite.setSize(
    sprite.texture.orig.width,
    sprite.texture.orig.height
);
```

#### See [#see-46]

* Sprite#width For setting width only
* Sprite#height For setting height only
* Sprite#texture For the source dimensions

#### Inherited from [#inherited-from-193]

`Sprite.setSize`

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-75]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-122]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-8]

If either child is not in container

#### See [#see-47]

* Container#setChildIndex For direct index placement
* Container#getChildIndex For getting current positions

#### Inherited from [#inherited-from-194]

`Sprite.swapChildren`

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-76]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-123]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-48]

* [Container#toLocal](#tolocal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-195]

`Sprite.toGlobal`

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-77]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-124]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-49]

* [Container#toGlobal](#toglobal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-196]

`Sprite.toLocal`

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-125]

`void`

#### Inherited from [#inherited-from-197]

`Sprite.unload`

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-126]

`void`

#### Inherited from [#inherited-from-198]

`Sprite.updateLocalTransform`

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-78]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-127]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-50]

* Container#setFromMatrix For matrix-based transforms
* Container#position For direct position access

#### Inherited from [#inherited-from-199]

`Sprite.updateTransform`


# Interface: ImageSpriteOptions (/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:950

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `SpriteOptions`

## Extended by [#extended-by]

* [`PixiVNJsonCanvasImageVideoShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageVideoShowProps)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`SpriteOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`SpriteOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`SpriteOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`SpriteOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`SpriteOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`SpriteOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`SpriteOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`SpriteOptions.align`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`SpriteOptions.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

`SpriteOptions.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`SpriteOptions.angle`

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

`SpriteOptions.autoGarbageCollect`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-12]

`SpriteOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

`SpriteOptions.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

`SpriteOptions.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-15]

`SpriteOptions.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

`SpriteOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

`SpriteOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

`SpriteOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

`SpriteOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

`SpriteOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-25]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-26]

`SpriteOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

`SpriteOptions.label`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`SpriteOptions.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

`SpriteOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

`SpriteOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-63]

`SpriteOptions.parent`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

`SpriteOptions.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

`SpriteOptions.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

`SpriteOptions.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-67]

`SpriteOptions.pivot`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-68]

`SpriteOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-69]

`SpriteOptions.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-70]

`SpriteOptions.rotation`

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-71]

`SpriteOptions.roundPixels`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-72]

`SpriteOptions.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-73]

`SpriteOptions.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-74]

`SpriteOptions.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-75]

`SpriteOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-76]

`SpriteOptions.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-77]

`SpriteOptions.tabIndex`

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-78]

`SpriteOptions.texture`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-79]

`SpriteOptions.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-80]

`SpriteOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-81]

`SpriteOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-82]

`SpriteOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-83]

`SpriteOptions.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-84]

`SpriteOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

`SpriteOptions.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-86]

`SpriteOptions.zIndex`


# Interface: MediaInterface (/pixi-vn-json/docs-entry/interfaces/MediaInterface)



Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:3

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `Pick`\<`Player`, `"blockTime"` | `"disposed"` | `"loaded"` | `"loop"` | `"loopEnd"` | `"loopStart"` | `"mute"` | `"now"` | `"playbackRate"` | `"reverse"` | `"restart"` | `"start"` | `"stop"` | `"chain"` | `"disconnect"` | `"volume"` | `"state"`>

## Properties [#properties]

### blockTime [#blocktime]

\> **blockTime**: `number`

Defined in: node_modules/tone/build/esm/core/context/ToneWithContext.d.ts:57

#### Inherited from [#inherited-from]

`Pick.blockTime`

***

### disposed [#disposed]

\> **disposed**: `boolean`

Defined in: node_modules/tone/build/esm/core/Tone.d.ts:52

#### Inherited from [#inherited-from-1]

`Pick.disposed`

***

### loaded [#loaded]

\> **loaded**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:189

#### Inherited from [#inherited-from-2]

`Pick.loaded`

***

### loop [#loop]

\> **loop**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:163

#### Inherited from [#inherited-from-3]

`Pick.loop`

***

### loopEnd [#loopend]

\> **loopEnd**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:149

#### Inherited from [#inherited-from-4]

`Pick.loopEnd`

***

### loopStart [#loopstart]

\> **loopStart**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:144

#### Inherited from [#inherited-from-5]

`Pick.loopStart`

***

### mute [#mute]

\> **mute**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:97

#### Inherited from [#inherited-from-6]

`Pick.mute`

***

### ~~muted~~ [#muted]

\> **muted**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:11

#### Deprecated [#deprecated]

Use [mute](#mute) instead.

***

### paused [#paused]

\> **paused**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:7

Whether the sound is currently paused.

***

### playbackRate [#playbackrate]

\> **playbackRate**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:174

#### Inherited from [#inherited-from-7]

`Pick.playbackRate`

***

### reverse [#reverse]

\> **reverse**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:184

#### Inherited from [#inherited-from-8]

`Pick.reverse`

***

### ~~speed~~ [#speed]

\> **speed**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:15

#### Deprecated [#deprecated-1]

Use [playbackRate](#playbackrate) instead.

***

### state [#state]

\> **state**: `BasicPlaybackState`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:89

#### Inherited from [#inherited-from-9]

`Pick.state`

***

### volume [#volume]

\> **volume**: `Param`\<`"decibels"`>

Defined in: node_modules/tone/build/esm/source/Source.d.ts:49

The volume of the output in decibels.

#### Example [#example]

```ts
const source = new Tone.PWMOscillator().toDestination();
source.volume.value = -6;
```

#### Inherited from [#inherited-from-10]

`Pick.volume`

## Methods [#methods]

### chain() [#chain]

\> **chain**(...`nodes`): `this`

Defined in: node_modules/tone/build/esm/core/context/ToneAudioNode.d.ts:125

Connect the output of this node to the rest of the nodes in series.

#### Parameters [#parameters]

##### nodes [#nodes]

...`InputNode`\[]

#### Returns [#returns]

`this`

#### Example [#example-1]

```ts
const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
player.autostart = true;
const filter = new Tone.AutoFilter(4).start();
const distortion = new Tone.Distortion(0.5);
// connect the player to the filter, distortion and then to the master output
player.chain(filter, distortion, Tone.Destination);
```

#### Inherited from [#inherited-from-11]

`Pick.chain`

***

### disconnect() [#disconnect]

\> **disconnect**(`destination?`, `outputNum?`, `inputNum?`): `this`

Defined in: node_modules/tone/build/esm/core/context/ToneAudioNode.d.ts:114

disconnect the output

#### Parameters [#parameters-1]

##### destination? [#destination]

`InputNode`

##### outputNum? [#outputnum]

`number`

##### inputNum? [#inputnum]

`number`

#### Returns [#returns-1]

`this`

#### Inherited from [#inherited-from-12]

`Pick.disconnect`

***

### now() [#now]

\> **now**(): `number`

Defined in: node_modules/tone/build/esm/core/context/ToneWithContext.d.ts:39

Return the current time of the Context clock plus the lookAhead.

#### Returns [#returns-2]

`number`

#### Example [#example-2]

```ts
setInterval(() => {
	console.log(Tone.now());
}, 100);
```

#### Inherited from [#inherited-from-13]

`Pick.now`

***

### restart() [#restart]

\> **restart**(`time?`, `offset?`, `duration?`): `this`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:114

Stop and then restart the player from the beginning (or offset)

#### Parameters [#parameters-2]

##### time? [#time]

`number`

When the player should start.

##### offset? [#offset]

`Time`

The offset from the beginning of the sample to start at.

##### duration? [#duration]

`Time`

How long the sample should play. If no duration is given,
it will default to the full length of the sample (minus any offset)

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-14]

`Pick.restart`

***

### start() [#start]

\> **start**(`time?`, `offset?`, `duration?`): `this`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:98

Play the buffer at the given startTime. Optionally add an offset
and/or duration which will play the buffer from a position
within the buffer for the given duration.

#### Parameters [#parameters-3]

##### time? [#time-1]

`Time`

When the player should start.

##### offset? [#offset-1]

`Time`

The offset from the beginning of the sample to start at.

##### duration? [#duration-1]

`Time`

How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)

#### Returns [#returns-4]

`this`

#### Inherited from [#inherited-from-15]

`Pick.start`

***

### stop() [#stop]

\> **stop**(`time?`): `this`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:125

Stop the source at the specified time. If no time is given,
stop the source now.

#### Parameters [#parameters-4]

##### time? [#time-2]

`Time`

When the source should be stopped.

#### Returns [#returns-5]

`this`

#### Example [#example-3]

```ts
const source = new Tone.Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
```

#### Inherited from [#inherited-from-16]

`Pick.stop`


# Interface: MoveInOutProps (/pixi-vn-json/docs-entry/interfaces/MoveInOutProps)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1668

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `BaseTransitionProps`.[`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Extended by [#extended-by]

* [`MoveInOutTransitionProps`](/pixi-vn-json/index/interfaces/MoveInOutTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1673

The direction of the movement.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: PushInOutProps (/pixi-vn-json/docs-entry/interfaces/PushInOutProps)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1682

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `BaseTransitionProps`.[`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Extended by [#extended-by]

* [`PushInOutTransitionProps`](/pixi-vn-json/index/interfaces/PushInOutTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1687

The direction of the push effect.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: ShowWithDissolveTransitionProps (/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1664

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `BaseTransitionProps`.[`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Extended by [#extended-by]

* [`DissolveTransitionProps`](/pixi-vn-json/index/interfaces/DissolveTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: ShowWithFadeTransitionProps (/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1666

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `BaseTransitionProps`.[`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Extended by [#extended-by]

* [`FadeTransitionProps`](/pixi-vn-json/index/interfaces/FadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: SoundPlayOptionsWithChannel (/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel)



Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:70

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `SoundPlayOptions`

## Extended by [#extended-by]

* [`PixiVNJsonSoundPlayProps`](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

#### Inherited from [#inherited-from]

`SoundPlayOptions.autostart`

***

### channel? [#channel]

\> `optional` **channel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:76

The alias of the audio channel to play the sound on. If the channel does
not exist it will be created automatically.
Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").

***

### delay? [#delay]

\> `optional` **delay?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:64

The delay in seconds before playback starts. If specified, playback is
scheduled to begin after the delay has elapsed rather than starting
immediately in a paused state.

#### Inherited from [#inherited-from-1]

`SoundPlayOptions.delay`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:68

The offset in seconds from the start of the sound at which to begin playback.

#### Inherited from [#inherited-from-2]

`SoundPlayOptions.elapsed`

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

#### Inherited from [#inherited-from-3]

`SoundPlayOptions.fadeIn`

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

#### Inherited from [#inherited-from-4]

`SoundPlayOptions.fadeOut`

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:48

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

#### Inherited from [#inherited-from-5]

`SoundPlayOptions.filters`

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

#### Inherited from [#inherited-from-6]

`SoundPlayOptions.loop`

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

#### Inherited from [#inherited-from-7]

`SoundPlayOptions.loopEnd`

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

#### Inherited from [#inherited-from-8]

`SoundPlayOptions.loopStart`

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

#### Inherited from [#inherited-from-9]

`SoundPlayOptions.mute`

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:56

#### Deprecated [#deprecated]

Use [mute](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps#mute) instead.

#### Inherited from [#inherited-from-10]

`SoundPlayOptions.muted`

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

#### Inherited from [#inherited-from-11]

`SoundPlayOptions.playbackRate`

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

#### Inherited from [#inherited-from-12]

`SoundPlayOptions.reverse`

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:52

#### Deprecated [#deprecated-1]

Use [playbackRate](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps#playbackrate) instead.

#### Inherited from [#inherited-from-13]

`SoundPlayOptions.speed`

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:35

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-14]

`SoundPlayOptions.volume`


# Interface: TextOptions (/pixi-vn-json/docs-entry/interfaces/TextOptions)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:946

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `Omit`\<`CanvasTextOptions`, `"on"`>.`AdditionalPositionsExtensionProps`

## Extended by [#extended-by]

* [`PixiVNJsonCanvasTextShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasTextShowProps)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`Omit.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`Omit.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`Omit.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`Omit.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`Omit.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`Omit.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`Omit.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`AdditionalPositionsExtensionProps.align`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`Omit.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:136

The anchor point of the text that controls the origin point for positioning and rotation.
Can be a number (same value for x/y) or a PointData object.

* (0,0) is top-left
* (0.5,0.5) is center
* (1,1) is bottom-right

```ts
// Set anchor to center
const text = new Text({
    text: 'Hello Pixi!',
    anchor: 0.5 // Same as { x: 0.5, y: 0.5 }
});
// Set anchor to top-left
const text2 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 0, y: 0 } // Top-left corner
});
// Set anchor to bottom-right
const text3 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 1, y: 1 } // Bottom-right corner
});
```

#### Default [#default-8]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-9]

`Omit.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`Omit.angle`

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

`Omit.autoGarbageCollect`

***

### autoGenerateMipmaps? [#autogeneratemipmaps]

\> `optional` **autoGenerateMipmaps?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:68

Whether to generate mipmaps for the text texture.
Improves rendering quality when the text is scaled down.

#### Default [#default-9]

```ts
undefined - Falls back to TextureSource.defaultOptions.autoGenerateMipmaps
```

#### Inherited from [#inherited-from-12]

`Omit.autoGenerateMipmaps`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-10]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-13]

`Omit.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-14]

`Omit.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-15]

`Omit.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-16]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-11]

```ts
false
```

#### Inherited from [#inherited-from-17]

`Omit.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-12]

```ts
true
```

#### Inherited from [#inherited-from-18]

`Omit.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-19]

`Omit.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-14]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-20]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-21]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-22]

`Omit.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-15]

```ts
0
```

#### Inherited from [#inherited-from-23]

`Omit.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-16]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

`Omit.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

`Omit.label`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`Omit.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-18]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-21]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-51]

`Omit.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-50]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-63]

`Omit.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-64]

`Omit.parent`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

`AdditionalPositionsExtensionProps.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

`AdditionalPositionsExtensionProps.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

`AdditionalPositionsExtensionProps.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-68]

`Omit.pivot`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-69]

`Omit.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-51]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-70]

`Omit.renderable`

***

### resolution? [#resolution]

> `optional` **resolution?**: `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:175

The resolution/device pixel ratio for rendering.
Higher values result in sharper text at the cost of performance.
Set to null for auto-resolution based on device.

#### Example [#example-60]

```ts
const text = new Text({
    text: 'Hello Pixi!',
    resolution: 2 // High DPI for sharper text
});
const autoResText = new Text({
    text: 'Auto Resolution',
    resolution: null // Use device's pixel ratio
});
```

#### Default [#default-52]

```ts
null
```

#### Inherited from [#inherited-from-71]

`Omit.resolution`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-72]

`Omit.rotation`

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:225

Whether to round the x/y position to whole pixels.
Enabling can prevent anti-aliasing of text edges but may cause slight position shifting.

#### Example [#example-62]

````ts
const text = new Text({
    text: 'Rounded Text',
    roundPixels: true // Rounds position to whole pixels
});
@default false

#### Inherited from

`Omit.roundPixels`

***

### scale?

&gt; `optional` **scale?**: `number` \| `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
````

#### Inherited from [#inherited-from-73]

`Omit.scale`

***

### setMask? [#setmask]

\> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-74]

`Omit.setMask`

***

### skew? [#skew]

\> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-63]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-53]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-75]

`Omit.skew`

***

### sortableChildren? [#sortablechildren]

\> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-64]

```ts
container.sortableChildren = true;
```

#### Default [#default-54]

```ts
false
```

#### Inherited from [#inherited-from-76]

`Omit.sortableChildren`

***

### sortDirty? [#sortdirty]

\> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-55]

```ts
false
@internal
```

#### Inherited from [#inherited-from-77]

`Omit.sortDirty`

***

### style? [#style]

\> `optional` **style?**: `TextStyle` | `TextStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:213

The style configuration for the text.
Can be a TextStyle instance or a configuration object.
Supports canvas text styles, HTML text styles, and bitmap text styles.

#### Example [#example-65]

````ts
const text = new Text({
    text: 'Styled Text',
    style: {
        fontSize: 24,
        fill: 0xff1010, // Red color
        fontFamily: 'Arial',
        align: 'center', // Center alignment
        stroke: { color: '#4a1850', width: 5 }, // Purple stroke
        dropShadow: {
            color: '#000000', // Black shadow
            blur: 4, // Shadow blur
            distance: 6 // Shadow distance
        }
    }
});
const htmlText = new HTMLText({
    text: 'HTML Styled Text',
    style: {
        fontSize: '20px',
        fill: 'blue',
        fontFamily: 'Verdana',
    }
});
const bitmapText = new BitmapText({
    text: 'Bitmap Styled Text',
    style: {
        fontName: 'Arial',
        fontSize: 32,
    }
})

#### Inherited from

`Omit.style`

***

### tabIndex?

> `optional` **tabIndex?**: `number`

Defined in: node\_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default

```ts
0
````

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-78]

`Omit.tabIndex`

***

### text? [#text]

> `optional` **text?**: `TextString`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:157

The text content to display. Use '\n' for line breaks.
Accepts strings, numbers, or objects with toString() method.

#### Example [#example-67]

```ts
const text = new Text({
    text: 'Hello Pixi!',
});
const multilineText = new Text({
    text: 'Line 1\nLine 2\nLine 3',
});
const numberText = new Text({
    text: 12345, // Will be converted to '12345'
});
const objectText = new Text({
    text: { toString: () =&gt; 'Object Text' }, // Custom toString
});
```

#### Default [#default-56]

```ts
''
```

#### Inherited from [#inherited-from-79]

`Omit.text`

***

### textureStyle? [#texturestyle]

> `optional` **textureStyle?**: `TextureStyle` | `TextureStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:62

Optional texture style to use for the text texture. This allows fine control over
how the text is rendered to a texture before being displayed.

The texture style can affect:

* Scale mode (nearest/linear)
* Resolution
* Format (rgb/rgba)
* Alpha handling

#### Example [#example-68]

```ts
const text = new Text({
    text: 'Crisp Text',
    textureStyle: {
        scaleMode: 'nearest', // Pixel-perfect scaling
    }
});
```

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-80]

`Omit.textureStyle`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-69]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-81]

`Omit.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-70]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-82]

`Omit.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-71]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-83]

`Omit.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-72]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-84]

`Omit.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

`AdditionalPositionsExtensionProps.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-73]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-86]

`Omit.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-87]

`AdditionalPositionsExtensionProps.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-74]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-88]

`Omit.zIndex`


# Interface: ZoomInOutProps (/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps)



Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1675

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `BaseTransitionProps`.[`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Extended by [#extended-by]

* [`ZoomInOutTransitionProps`](/pixi-vn-json/index/interfaces/ZoomInOutTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

`BaseTransitionProps.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1680

The direction of the zoom effect.

#### Default [#default-3]

```ts
"right"
```

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Type Alias: AnimationOptions (/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)



\> **AnimationOptions** = `AnimationOptionsCommon` & `Omit`\<`CommonTickerProps`, `"startOnlyIfHaveTexture"`>

Defined in: node_modules/@drincs/pixi-vn/dist/motion.d.ts:17


# Type Alias: SequenceOptions (/pixi-vn-json/docs-entry/type-aliases/SequenceOptions)



\> **SequenceOptions** = `SequenceOptions$1` & `Omit`\<`CommonTickerProps`, `"startOnlyIfHaveTexture"`>

Defined in: node_modules/@drincs/pixi-vn/dist/motion.d.ts:21


# Pixi’VN + Json Integration (/pixi-vn-json)



![pixi-vn-cover-json](https://github.com/user-attachments/assets/ec9aa39e-6e3c-4198-8a65-e1fce1f1d637)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-json" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn-json?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-json" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/pixi-vn-json" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/pixi-vn-json" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/pixi-vn-json?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-json" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/pixi-vn-json" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

Pixi’VN can be integrated with JSON files to create a visual novel. This method is useful for:

* Add a new narrative to Pixi’VN (It was used to create the integration with **_ink_**
* Create a external tool to create visual novels with Pixi’VN

( In both these cases it is advisable to notify the developers of Pixi’VN to add the new feature to be helped )

<Mermaid
  chart="flowchart LR;
    K[RenPy] ---> Json;
    H[ink] ---> Json;
    I[Twine] ---> Json;
    J[Yarn Spinner] ---> Json;
    Json[&#x22;Pixi’VN + Json&#x22;] ===> PixiVN;
    PixiVN[&#x22;Pixi’VN&#x22;]"
/>

## How use Pixi’VN + Json? [#how-use-pixivn--json]

First of all you need to install the following library:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @drincs/pixi-vn-json
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @drincs/pixi-vn-json
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @drincs/pixi-vn-json
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @drincs/pixi-vn-json
    ```
  </CodeBlockTab>
</CodeBlockTabs>

All you need to do to use this integration is create a object using the \<DynamicLink href="/json/PixiVNJson">`PixiVNJson` Model</DynamicLink> and use the `importPixiVNJson()` function to import the object.

```ts title="labels.json"
{
    "$schema": "https://pixi-vn.com/schemas/latest/schema.json",
    "labels": {
        "back_in_london": [
            {
                "dialogue": "We arrived into London at 9.45pm exactly.",
            },
            {
                "labelToOpen": {
                    "label": "hurry_home",
                    "type": "jump",
                },
            },
        ],
        "hurry_home": [
            {
                "dialogue": "We hurried home to Savile Row as fast as we could.",
            },
            {
                "end": "label_end",
            },
        ]
    }
}
```

```ts title="main.ts"
import { PixiVNJson, importPixiVNJson } from "@drincs/pixi-vn-json";
import json from "./labels.json";

importPixiVNJson(json);
```

After that you can run the `back_in_london` label with \<DynamicLink href="/start/labels#run-a-label">Pixi’VN functions</DynamicLink>.

```ts title="main.ts"
import { narration } from "@drincs/pixi-vn";

narration.call(`back_in_london`, {});
```


# Class: LabelJson<T> (/pixi-vn-json/index/classes/LabelJson)



Defined in: [src/interpreter/LabelJson.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L53)

A label whose steps are defined by a plain JSON structure ([PixiVNJsonLabelStep](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)\[]).

`LabelJson` bridges pixi-vn's label system and the JSON script format: each step is
lazily converted to a StepLabelType closure that resolves dialogues, choices,
operations, and conditional overrides at runtime via [JsonUnifier](/pixi-vn-json/core/classes/JsonUnifier).

## Extends [#extends]

* `LabelAbstract`\<`LabelJson`\<`T`>, `T`>

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = `object`

The type of the props object passed between steps.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new LabelJson**\<`T`>(`id`, `steps`, `props?`, `options?`): `LabelJson`\<`T`>

Defined in: [src/interpreter/LabelJson.ts:59](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L59)

#### Parameters [#parameters]

##### id [#id]

`string`

is the id of the label

##### steps [#steps]

([`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep) | (() => [`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)))\[]

is the list of steps that the label will perform

##### props? [#props]

`LabelProps`\<`LabelJson`\<`T`>, `number`>

is the properties of the label

##### options? [#options]

`LabelJsonOptions` = `{}`

#### Returns [#returns]

`LabelJson`\<`T`>

#### Overrides [#overrides]

`LabelAbstract<LabelJson<T>, T>.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/narration.d.ts:519

Get the id of the label. This variable is used in the system to get the label by id, RegisteredLabels.get

#### Inherited from [#inherited-from]

`LabelAbstract.id`

## Accessors [#accessors]

### onLoadingLabel [#onloadinglabel]

#### Get Signature [#get-signature]

\> **get** **onLoadingLabel**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/narration.d.ts:539

Is a function that will be executed in [onStepStart](#onstepstart) if the id of the step is 0
and when the user laods a save file.
When you load a save file, will be executed all onLoadingLabel functions of the narration.openedLabels.
It is useful for example to make sure all images used have been cached

##### Example [#example]

```ts title="content/labels/start.label.ts"
newLabel("start", [], {
    onLoadingLabel: async (stepId, label) => {
        await Assets.load('path/to/image1.png')
        await Assets.load('path/to/image2.png')
    }
})
```

##### Returns [#returns-1]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

#### Inherited from [#inherited-from-1]

`LabelAbstract.onLoadingLabel`

***

### onStepEnd [#onstepend]

#### Get Signature [#get-signature-1]

\> **get** **onStepEnd**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/narration.d.ts:541

A function executed after each `step`. See more \<DynamicLink href="/start/labels-advanced#onstepend">here</DynamicLink>.

##### Example [#example-1]

```ts
const startLabel = newLabel("start", [
    async () => {
        await showImage("image1", "path/to/image1.png")
        await showImage("image2", "path/to/image2.png")
    }
], {
    onLoadingLabel: async (stepIndex, label) => {
        await Assets.load("path/to/image1.png")
        await Assets.load("path/to/image2.png")
    }
})
```

##### Returns [#returns-2]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

#### Inherited from [#inherited-from-2]

`LabelAbstract.onStepEnd`

***

### onStepStart [#onstepstart]

#### Get Signature [#get-signature-2]

\> **get** **onStepStart**(): ((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/narration.d.ts:537

A function executed before each `step`.

##### Example [#example-2]

```ts
const startLabel = newLabel("start", [
    () => {
        narration.dialogue = "Step 1"
    },
    () => {
        narration.dialogue = "Step 2"
    }
], {
    onStepStart: (stepIndex, label) => {
        console.log(`Step ${stepIndex} started`)
    }
})
```

##### Returns [#returns-3]

((`stepId`, `label`) => `void` | `Promise`\<`void`>) | `undefined`

#### Inherited from [#inherited-from-3]

`LabelAbstract.onStepStart`

***

### stepCount [#stepcount]

#### Get Signature [#get-signature-3]

\> **get** **stepCount**(): `number`

Defined in: [src/interpreter/LabelJson.ts:106](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L106)

Get the number of steps in the label. This variable is used in the system to get the number of steps in the label.

##### Returns [#returns-4]

`number`

The number of steps in the label

#### Overrides [#overrides-1]

`LabelAbstract.stepCount`

***

### steps [#steps-1]

#### Get Signature [#get-signature-4]

\> **get** **steps**(): `StepLabelType`\<`T`>\[]

Defined in: [src/interpreter/LabelJson.ts:101](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L101)

##### Returns [#returns-5]

`StepLabelType`\<`T`>\[]

## Methods [#methods]

### getStepById() [#getstepbyid]

\> **getStepById**(`stepId`): `StepLabelType`\<`T`> | `undefined`

Defined in: [src/interpreter/LabelJson.ts:109](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L109)

Get the step by id

#### Parameters [#parameters-1]

##### stepId [#stepid]

`number`

Id of the step

#### Returns [#returns-6]

`StepLabelType`\<`T`> | `undefined`

The step or undefined if it does not exist

#### Overrides [#overrides-2]

`LabelAbstract.getStepById`

***

### getStepSha() [#getstepsha]

\> **getStepSha**(`index`): `string` | `undefined`

Defined in: [src/interpreter/LabelJson.ts:131](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/LabelJson.ts#L131)

Returns the SHA-1 hash of the raw step at the given index.
Can be used to detect step changes across label reloads.

#### Parameters [#parameters-2]

##### index [#index]

`number`

Zero-based index of the step.

#### Returns [#returns-7]

`string` | `undefined`

The hex SHA-1 string, or `undefined` if the index is out of range.

#### Overrides [#overrides-3]

`LabelAbstract.getStepSha`


# Function: importPixiVNJson() (/pixi-vn-json/index/functions/importPixiVNJson)



\> **importPixiVNJson**(`values`, `options?`): `Promise`\<`void`>

Defined in: [src/interpreter/importer.ts:14](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/interpreter/importer.ts#L14)

Import a Pixi'VN JSON to the system.
This feature was created to give other developers the ability to create tools that can generate Pixi'VN labels or that generate Pixi'VN after extracting information from a programming language designed for writing narratives.

## Parameters [#parameters]

### values [#values]

`string` | [`PixiVNJson`](/pixi-vn-json/index/interfaces/PixiVNJson) | (`string` | [`PixiVNJson`](/pixi-vn-json/index/interfaces/PixiVNJson))\[]

The Pixi'VN JSON to be imported

### options? [#options]

`LabelJsonOptions` = `{}`

## Returns [#returns]

`Promise`\<`void`>


# Function: init() (/pixi-vn-json/index/functions/init)



\> **init**(): `void`

Defined in: [src/index.ts:37](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/index.ts#L37)

Initialises the pixi-vn-json system by registering all default operation handlers
(canvas, sound, assets, storage, narration, etc.) into the [JsonUnifier](/pixi-vn-json/core/classes/JsonUnifier).

Call this function once at application startup, before importing any JSON labels.

## Returns [#returns]

`void`


# index (/pixi-vn-json/index)



## Namespaces [#namespaces]

* [TextReplaces](/pixi-vn-json/index/namespaces/TextReplaces)
* [translator](/pixi-vn-json/index/namespaces/translator)
* [VariableGetter](/pixi-vn-json/index/namespaces/VariableGetter)

## Classes [#classes]

* [LabelJson](/pixi-vn-json/index/classes/LabelJson)

## Interfaces [#interfaces]

* [DissolveTransitionProps](/pixi-vn-json/index/interfaces/DissolveTransitionProps)
* [FadeTransitionProps](/pixi-vn-json/index/interfaces/FadeTransitionProps)
* [MoveInOutTransitionProps](/pixi-vn-json/index/interfaces/MoveInOutTransitionProps)
* [PixiVNJson](/pixi-vn-json/index/interfaces/PixiVNJson)
* [PixiVNJsonAnimateBaseOptions](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateBaseOptions)
* [PixiVNJsonAnimateSequenceOptions](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions)
* [PixiVNJsonArithmeticOperationsArithmetic](/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmetic)
* [PixiVNJsonArithmeticOperationsArithmeticSingle](/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmeticSingle)
* [PixiVNJsonCanvasImageContainerShowProps](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageContainerShowProps)
* [PixiVNJsonCanvasImageVideoShowProps](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageVideoShowProps)
* [PixiVNJsonCanvasTextShowProps](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasTextShowProps)
* [PixiVNJsonIfElse](/pixi-vn-json/index/interfaces/PixiVNJsonIfElse)
* [PixiVNJsonSoundEditProps](/pixi-vn-json/index/interfaces/PixiVNJsonSoundEditProps)
* [PixiVNJsonSoundPlayProps](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps)
* [PushInOutTransitionProps](/pixi-vn-json/index/interfaces/PushInOutTransitionProps)
* [ZoomInOutTransitionProps](/pixi-vn-json/index/interfaces/ZoomInOutTransitionProps)

## Type Aliases [#type-aliases]

* [DissolveTransition](/pixi-vn-json/index/type-aliases/DissolveTransition)
* [FadeTransition](/pixi-vn-json/index/type-aliases/FadeTransition)
* [MoveInOutTransition](/pixi-vn-json/index/type-aliases/MoveInOutTransition)
* [PixiVNJsonAnimateBase](/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateBase)
* [PixiVNJsonAnimateSequence](/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateSequence)
* [PixiVNJsonArithmeticOperations](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations)
* [PixiVNJsonCanvas](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvas)
* [PixiVNJsonCanvasAnimate](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasAnimate)
* [PixiVNJsonCanvasClear](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasClear)
* [PixiVNJsonCanvasEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEdit)
* [PixiVNJsonCanvasEffect](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEffect)
* [PixiVNJsonCanvasImageContainerShow](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageContainerShow)
* [PixiVNJsonCanvasImageVideoShow](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageVideoShow)
* [PixiVNJsonCanvasRemove](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasRemove)
* [PixiVNJsonCanvasShow](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasShow)
* [PixiVNJsonCanvasTextShow](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasTextShow)
* [PixiVNJsonChoice](/pixi-vn-json/index/type-aliases/PixiVNJsonChoice)
* [PixiVNJsonChoiceGet](/pixi-vn-json/index/type-aliases/PixiVNJsonChoiceGet)
* [PixiVNJsonChoices](/pixi-vn-json/index/type-aliases/PixiVNJsonChoices)
* [PixiVNJsonComparation](/pixi-vn-json/index/type-aliases/PixiVNJsonComparation)
* [PixiVNJsonComparationOperatorsType](/pixi-vn-json/index/type-aliases/PixiVNJsonComparationOperatorsType)
* [PixiVNJsonConditionalOperation](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalOperation)
* [PixiVNJsonConditionalResultToCombine](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalResultToCombine)
* [PixiVNJsonConditionalStatements](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)
* [PixiVNJsonConditions](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)
* [PixiVNJsonDialog](/pixi-vn-json/index/type-aliases/PixiVNJsonDialog)
* [PixiVNJsonDialogText](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogText)
* [PixiVNJsonDialogue](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogue)
* [PixiVNJsonFunction](/pixi-vn-json/index/type-aliases/PixiVNJsonFunction)
* [PixiVNJsonImageContainerEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonImageContainerEdit)
* [PixiVNJsonImageEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonImageEdit)
* [PixiVNJsonInputRequest](/pixi-vn-json/index/type-aliases/PixiVNJsonInputRequest)
* [PixiVNJsonLabelGet](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelGet)
* [PixiVNJsonLabels](/pixi-vn-json/index/type-aliases/PixiVNJsonLabels)
* [PixiVNJsonLabelStep](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)
* [PixiVNJsonLabelToOpen](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen)
* [PixiVNJsonLogicGet](/pixi-vn-json/index/type-aliases/PixiVNJsonLogicGet)
* [PixiVNJsonMediaTransiotions](/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)
* [PixiVNJsonNarration](/pixi-vn-json/index/type-aliases/PixiVNJsonNarration)
* [PixiVNJsonOnlyStorageSet](/pixi-vn-json/index/type-aliases/PixiVNJsonOnlyStorageSet)
* [PixiVNJsonOperation](/pixi-vn-json/index/type-aliases/PixiVNJsonOperation)
* [PixiVNJsonOperationString](/pixi-vn-json/index/type-aliases/PixiVNJsonOperationString)
* [PixiVNJsonParamGet](/pixi-vn-json/index/type-aliases/PixiVNJsonParamGet)
* [PixiVNJsonSound](/pixi-vn-json/index/type-aliases/PixiVNJsonSound)
* [PixiVNJsonSoundEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundEdit)
* [PixiVNJsonSoundPauseResume](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPauseResume)
* [PixiVNJsonSoundPlay](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPlay)
* [PixiVNJsonSoundRemove](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundRemove)
* [PixiVNJsonStepSwitch](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitch)
* [PixiVNJsonStepSwitchElementsType](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementsType)
* [PixiVNJsonStepSwitchElementType](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementType)
* [PixiVNJsonStorageGet](/pixi-vn-json/index/type-aliases/PixiVNJsonStorageGet)
* [PixiVNJsonTextEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonTextEdit)
* [PixiVNJsonUnionCondition](/pixi-vn-json/index/type-aliases/PixiVNJsonUnionCondition)
* [PixiVNJsonUnknownEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonUnknownEdit)
* [PixiVNJsonValueGet](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet)
* [PixiVNJsonValueSet](/pixi-vn-json/index/type-aliases/PixiVNJsonValueSet)
* [PixiVNJsonVideoEdit](/pixi-vn-json/index/type-aliases/PixiVNJsonVideoEdit)
* [PixiVNJsonVideoPauseResume](/pixi-vn-json/index/type-aliases/PixiVNJsonVideoPauseResume)
* [PushInOutTransition](/pixi-vn-json/index/type-aliases/PushInOutTransition)
* [ReplaceHandler](/pixi-vn-json/index/type-aliases/ReplaceHandler)
* [ReplaceHandlerOptions](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions)
* [VariableGetterHandler](/pixi-vn-json/index/type-aliases/VariableGetterHandler)
* [ZoomInOutTransition](/pixi-vn-json/index/type-aliases/ZoomInOutTransition)

## Variables [#variables]

* [PIXIVNJSON_PARAM_ID](/pixi-vn-json/index/variables/PIXIVNJSON_PARAM_ID)
* [PIXIVNJSON_SCHEMA_URL](/pixi-vn-json/index/variables/PIXIVNJSON_SCHEMA_URL)
* [PixiVNJsonComparationOperators](/pixi-vn-json/index/variables/PixiVNJsonComparationOperators)

## Functions [#functions]

* [importPixiVNJson](/pixi-vn-json/index/functions/importPixiVNJson)
* [init](/pixi-vn-json/index/functions/init)


# Interface: DissolveTransitionProps (/pixi-vn-json/index/interfaces/DissolveTransitionProps)



Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:13](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L13)

Configuration options for the dissolve transition.

## Extends [#extends]

* [`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`aliasToRemoveAfter`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#aliastoremoveafter)

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`autoplay`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`bounce`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`bounceDamping`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`bounceStiffness`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`completeOnContinue`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`damping`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`delay`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`delayChildren`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`driver`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`duration`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`ease`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`from`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`inherit`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`isSync`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`mass`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`max`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`min`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`modifyTarget`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`path`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`power`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`reduceMotion`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`restDelta`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`restSpeed`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`skipAnimations`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`staggerChildren`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`staggerDirection`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`startTime`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`stiffness`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`tickerAliasToResume`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#tickeraliastoresume)

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`tickerIdToResume`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#tickeridtoresume)

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`timeConstant`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`times`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`type`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`velocity`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`visualDuration`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

[`ShowWithDissolveTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps).[`when`](/pixi-vn-json/docs-entry/interfaces/ShowWithDissolveTransitionProps#when)


# Interface: FadeTransitionProps (/pixi-vn-json/index/interfaces/FadeTransitionProps)



Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:32](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L32)

Configuration options for the fade transition.

## Extends [#extends]

* [`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`aliasToRemoveAfter`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#aliastoremoveafter)

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`autoplay`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`bounce`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`bounceDamping`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`bounceStiffness`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`completeOnContinue`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`damping`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`delay`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`delayChildren`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#delaychildren)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`driver`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`duration`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`ease`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`from`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`inherit`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`isSync`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`mass`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`max`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`min`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`modifyTarget`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`path`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`power`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`reduceMotion`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`restDelta`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`restSpeed`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`skipAnimations`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`staggerChildren`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`staggerDirection`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`startTime`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`stiffness`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`tickerAliasToResume`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#tickeraliastoresume)

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`tickerIdToResume`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#tickeridtoresume)

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`timeConstant`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`times`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`type`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`velocity`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`visualDuration`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

[`ShowWithFadeTransitionProps`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps).[`when`](/pixi-vn-json/docs-entry/interfaces/ShowWithFadeTransitionProps#when)


# Interface: MoveInOutTransitionProps (/pixi-vn-json/index/interfaces/MoveInOutTransitionProps)



Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:51](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L51)

Configuration options for the move transition (direction, duration, easing, etc.).

## Extends [#extends]

* [`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`aliasToRemoveAfter`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#aliastoremoveafter)

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`autoplay`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`bounce`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`bounceDamping`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`bounceStiffness`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`completeOnContinue`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`damping`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`delay`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`delayChildren`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1673

The direction of the movement.

#### Default [#default-3]

```ts
"right"
```

#### Inherited from [#inherited-from-9]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`direction`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#direction)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-10]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`driver`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`duration`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-12]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`ease`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-14]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`from`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`inherit`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-16]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`isSync`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`mass`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`max`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`min`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`modifyTarget`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`path`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`power`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`reduceMotion`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`restDelta`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`restSpeed`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`skipAnimations`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`staggerChildren`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`staggerDirection`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-32]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`startTime`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`stiffness`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`tickerAliasToResume`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#tickeraliastoresume)

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-35]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`tickerIdToResume`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#tickeridtoresume)

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`timeConstant`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-37]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`times`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`type`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-39]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`velocity`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`visualDuration`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`MoveInOutProps`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps).[`when`](/pixi-vn-json/docs-entry/interfaces/MoveInOutProps#when)


# Interface: PixiVNJson (/pixi-vn-json/index/interfaces/PixiVNJson)



Defined in: [src/schema/PixiVNJson.ts:8](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJson.ts#L8)

PixiVNJson It can be defined as a programming language to write a narrative written in json.

## Properties [#properties]

### $schema? [#schema]

\> `optional` **$schema?**: `string`

Defined in: [src/schema/PixiVNJson.ts:19](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJson.ts#L19)

The URI of the JSON Schema that describes and validates this document.

You can point to a specific version of the schema, for example:

* `"https://pixi-vn.com/schemas/1.13.0/schema.json"` — pin to a specific version
* `"https://pixi-vn.com/schemas/latest/schema.json"` — always use the latest version

Most editors (VS Code, WebStorm, etc.) use this field to provide
auto-completion, hover documentation, and validation for the document.

***

### initialOperations? [#initialoperations]

\> `optional` **initialOperations?**: ([`PixiVNJsonValueSet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueSet) | [`PixiVNJsonIfElse`](/pixi-vn-json/index/interfaces/PixiVNJsonIfElse)\<[`PixiVNJsonValueSet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueSet)>)\[]

Defined in: [src/schema/PixiVNJson.ts:25](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJson.ts#L25)

The operations to be executed before the narrative starts.
For the set storage: They will be set only if there are no variables with the same key already.
For the det tempstorage: if there are variables with the same key already, they will be overwritten.

***

### labels? [#labels]

\> `optional` **labels?**: [`PixiVNJsonLabels`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabels)

Defined in: [src/schema/PixiVNJson.ts:29](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJson.ts#L29)

The labels to be used in the narrative. They will be added to the system


# Interface: PixiVNJsonAnimateBaseOptions (/pixi-vn-json/index/interfaces/PixiVNJsonAnimateBaseOptions)



Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:14](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L14)

Additional options controlling the animation (duration, easing, repeat, etc.).

## Extends [#extends]

* [`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:230

A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
When true, calling narration.continue() forces the current content to complete before advancing to the next narrative step.

#### Default [#default-1]

```ts
false
```

#### Inherited from [#inherited-from-5]

`AnimationOptions.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-19]

`AnimationOptions.modifyTarget`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-20]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-21]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-22]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-23]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-26]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-27]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-28]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-29]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-30]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-31]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-32]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-33]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-35]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-36]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-37]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-38]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-39]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-40]

`AnimationOptions.when`


# Interface: PixiVNJsonAnimateSequenceOptions (/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions)



Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:40](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L40)

Additional options controlling the sequence playback.

## Extends [#extends]

* [`SequenceOptions`](/pixi-vn-json/docs-entry/type-aliases/SequenceOptions)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`SequenceOptions.aliasToRemoveAfter`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:230

A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
When true, calling narration.continue() forces the current content to complete before advancing to the next narrative step.

#### Default [#default-1]

```ts
false
```

#### Inherited from [#inherited-from-1]

`SequenceOptions.completeOnContinue`

***

### defaultTransition? [#defaulttransition]

\> `optional` **defaultTransition?**: `Transition`

Defined in: node_modules/framer-motion/dist/dom.d.ts:63

#### Inherited from [#inherited-from-2]

`SequenceOptions.defaultTransition`

***

### delay? [#delay]

\> `optional` **delay?**: `number`

Defined in: node_modules/framer-motion/dist/dom.d.ts:61

#### Inherited from [#inherited-from-3]

`SequenceOptions.delay`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/framer-motion/dist/dom.d.ts:62

#### Inherited from [#inherited-from-4]

`SequenceOptions.duration`

***

### onComplete? [#oncomplete]

\> `optional` **onComplete?**: () => `void`

Defined in: node_modules/framer-motion/dist/dom.d.ts:66

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-5]

`SequenceOptions.onComplete`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/framer-motion/dist/dom.d.ts:64

#### Inherited from [#inherited-from-6]

`SequenceOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-7]

`SequenceOptions.repeat`

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-8]

`SequenceOptions.repeatDelay`

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-9]

`SequenceOptions.repeatType`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/framer-motion/dist/dom.d.ts:65

#### Inherited from [#inherited-from-10]

`SequenceOptions.skipAnimations`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-2]

```ts
[]
```

#### Inherited from [#inherited-from-11]

`SequenceOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-3]

```ts
[]
```

#### Inherited from [#inherited-from-12]

`SequenceOptions.tickerIdToResume`


# Interface: PixiVNJsonArithmeticOperationsArithmetic (/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmetic)



Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:8](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L8)

Binary arithmetic operation between two values (left OP right).

## Properties [#properties]

### leftValue [#leftvalue]

\> **leftValue**: [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) | `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<PixiVNJsonArithmeticOperations | StorageElementType | PixiVNJsonValueGet>

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:13](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L13)

Left value of the arithmetic operation

***

### operator [#operator]

\> **operator**: `"*"` | `"/"` | `"+"` | `"-"` | `"%"` | `"POW"` | `"RANDOM"` | `"INTERSECTION"`

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:41](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L41)

Operator of the arithmetic operation:

* `"*"` multiplication
* `"/"` division
* `"+"` addition (concatenation for strings and arrays)
* `"-"` subtraction (removal of elements for arrays)
* `"%"` modulo
* `"POW"` exponentiation
* `"RANDOM"` random integer between leftValue and rightValue (inclusive)
* `"INTERSECTION"` intersection of two arrays (only elements present in both arrays are included in the result)

***

### rightValue [#rightvalue]

\> **rightValue**: [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) | `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<PixiVNJsonArithmeticOperations | StorageElementType | PixiVNJsonValueGet>

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L23)

Right value of the arithmetic operation

***

### type [#type]

\> **type**: `"arithmetic"`

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:9](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L9)


# Interface: PixiVNJsonArithmeticOperationsArithmeticSingle (/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmeticSingle)



Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:47](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L47)

Unary arithmetic operation applied to a single value (e.g. INT, FLOOR, FLOAT).

## Properties [#properties]

### leftValue [#leftvalue]

\> **leftValue**: [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) | `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<PixiVNJsonArithmeticOperations | StorageElementType | PixiVNJsonValueGet>

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:52](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L52)

Left value of the arithmetic operation

***

### operator [#operator]

\> **operator**: `"INT"` | `"FLOOR"` | `"FLOAT"`

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:65](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L65)

Operator of the arithmetic operation:

* `"INT"` truncates the value to an integer (removes the decimal part)
* `"FLOOR"` rounds down to the nearest integer
* `"FLOAT"` converts the value to a floating-point number

***

### type [#type]

\> **type**: `"arithmeticsingle"`

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:48](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L48)


# Interface: PixiVNJsonCanvasImageContainerShowProps (/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageContainerShowProps)



Defined in: [src/schema/PixiVNJsonCanvas.ts:48](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L48)

Display options for an image container.

## Extends [#extends]

* [`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions)\<[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite)>

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessible`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessibleChildren`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessibleHint`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessiblePointerEvents`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessibleText`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessibleTitle`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`accessibleType`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`align`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`alpha`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:919

#### Inherited from [#inherited-from-9]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`anchor`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`angle`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#angle)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-11]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`blendMode`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-12]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`boundsArea`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-13]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`cacheAsTexture`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: [`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite)\<`ImageSpriteMemory`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-14]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`children`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-15]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`cullable`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-16]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`cullableChildren`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-17]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`cullArea`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-18]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-19]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-20]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`filters`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-21]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`height`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-22]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-23]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-25]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`isRenderGroup`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-26]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`label`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`mask`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-28]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-49]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`onRender`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-61]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`origin`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-62]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`parent`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-63]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`percentagePosition`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`percentageX`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`percentageY`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-66]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`pivot`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`position`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-68]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`renderable`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-69]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`rotation`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#rotation)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-70]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`scale`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-71]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`setMask`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-72]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`skew`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-73]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`sortableChildren`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-74]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`sortDirty`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-75]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`tabIndex`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#tabindex)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-76]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`tint`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-77]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`visible`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-78]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`width`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-79]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`x`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-80]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`xAlign`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-81]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`y`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-82]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`yAlign`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-83]

[`ImageContainerOptions`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions).[`zIndex`](/pixi-vn-json/docs-entry/interfaces/ImageContainerOptions#zindex)


# Interface: PixiVNJsonCanvasImageVideoShowProps (/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageVideoShowProps)



Defined in: [src/schema/PixiVNJsonCanvas.ts:20](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L20)

Display options (position, scale, alpha, etc.) for an image or video sprite.

## Extends [#extends]

* [`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessible`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessibleChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessibleHint`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessiblePointerEvents`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessibleText`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessibleTitle`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`accessibleType`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`align`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`alpha`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`anchor`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`angle`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`autoGarbageCollect`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#autogarbagecollect)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-12]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`blendMode`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`boundsArea`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`cacheAsTexture`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-15]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`children`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`cullable`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`cullableChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`cullArea`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`filters`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`height`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-25]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-26]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`isRenderGroup`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-27]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`label`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`mask`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-50]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`onRender`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-62]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`origin`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-63]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`parent`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-64]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`percentagePosition`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`percentageX`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`percentageY`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-67]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`pivot`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`position`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-69]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`renderable`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#renderable)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-70]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`rotation`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-71]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`roundPixels`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#roundpixels)

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-72]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`scale`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#scale)

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-73]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`setMask`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#setmask)

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-74]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`skew`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#skew)

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-75]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`sortableChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#sortablechildren)

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-76]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`sortDirty`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#sortdirty)

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-77]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`tabIndex`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#tabindex)

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-78]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`texture`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#texture)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-79]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`tint`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-80]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`visible`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-81]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`width`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-82]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`x`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-83]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`xAlign`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-84]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`y`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`yAlign`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-86]

[`ImageSpriteOptions`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions).[`zIndex`](/pixi-vn-json/docs-entry/interfaces/ImageSpriteOptions#zindex)


# Interface: PixiVNJsonCanvasTextShowProps (/pixi-vn-json/index/interfaces/PixiVNJsonCanvasTextShowProps)



Defined in: [src/schema/PixiVNJsonCanvas.ts:76](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L76)

Display options (font, style, position, etc.) for a text element.

## Extends [#extends]

* [`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions)

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessible`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessibleChildren`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessibleHint`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessiblePointerEvents`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessibleText`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessibleTitle`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`accessibleType`](/pixi-vn-json/docs-entry/interfaces/TextOptions#accessibletype)

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`align`](/pixi-vn-json/docs-entry/interfaces/TextOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`alpha`](/pixi-vn-json/docs-entry/interfaces/TextOptions#alpha)

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:136

The anchor point of the text that controls the origin point for positioning and rotation.
Can be a number (same value for x/y) or a PointData object.

* (0,0) is top-left
* (0.5,0.5) is center
* (1,1) is bottom-right

```ts
// Set anchor to center
const text = new Text({
    text: 'Hello Pixi!',
    anchor: 0.5 // Same as { x: 0.5, y: 0.5 }
});
// Set anchor to top-left
const text2 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 0, y: 0 } // Top-left corner
});
// Set anchor to bottom-right
const text3 = new Text({
    text: 'Hello Pixi!',
    anchor: { x: 1, y: 1 } // Bottom-right corner
});
```

#### Default [#default-8]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-9]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`anchor`](/pixi-vn-json/docs-entry/interfaces/TextOptions#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`angle`](/pixi-vn-json/docs-entry/interfaces/TextOptions#angle)

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`autoGarbageCollect`](/pixi-vn-json/docs-entry/interfaces/TextOptions#autogarbagecollect)

***

### autoGenerateMipmaps? [#autogeneratemipmaps]

\> `optional` **autoGenerateMipmaps?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:68

Whether to generate mipmaps for the text texture.
Improves rendering quality when the text is scaled down.

#### Default [#default-9]

```ts
undefined - Falls back to TextureSource.defaultOptions.autoGenerateMipmaps
```

#### Inherited from [#inherited-from-12]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`autoGenerateMipmaps`](/pixi-vn-json/docs-entry/interfaces/TextOptions#autogeneratemipmaps)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-10]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-13]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`blendMode`](/pixi-vn-json/docs-entry/interfaces/TextOptions#blendmode)

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-14]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`boundsArea`](/pixi-vn-json/docs-entry/interfaces/TextOptions#boundsarea)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-15]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`cacheAsTexture`](/pixi-vn-json/docs-entry/interfaces/TextOptions#cacheastexture)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-16]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`children`](/pixi-vn-json/docs-entry/interfaces/TextOptions#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-11]

```ts
false
```

#### Inherited from [#inherited-from-17]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`cullable`](/pixi-vn-json/docs-entry/interfaces/TextOptions#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-12]

```ts
true
```

#### Inherited from [#inherited-from-18]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`cullableChildren`](/pixi-vn-json/docs-entry/interfaces/TextOptions#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-19]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`cullArea`](/pixi-vn-json/docs-entry/interfaces/TextOptions#cullarea)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-14]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-20]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`cursor`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-21]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`eventMode`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-22]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`filters`](/pixi-vn-json/docs-entry/interfaces/TextOptions#filters)

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-15]

```ts
0
```

#### Inherited from [#inherited-from-23]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`height`](/pixi-vn-json/docs-entry/interfaces/TextOptions#height)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-24]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`hitArea`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-json/docs-entry/interfaces/ImageSprite#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactive`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-16]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`interactiveChildren`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`isRenderGroup`](/pixi-vn-json/docs-entry/interfaces/TextOptions#isrendergroup)

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-28]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`label`](/pixi-vn-json/docs-entry/interfaces/TextOptions#label)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`mask`](/pixi-vn-json/docs-entry/interfaces/TextOptions#mask)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-18]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-30]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-31]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobalpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-21]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-32]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onglobaltouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-33]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousedown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-34]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmousemove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onmouseupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointercancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerenter`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerleave`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointermove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerout`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerover`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointertap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onpointerupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-51]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`onRender`](/pixi-vn-json/docs-entry/interfaces/TextOptions#onrender)

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightclick`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightdown`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightup`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onrightupoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontap`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchcancel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchend`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchendoutside`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchmove`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`ontouchstart`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-50]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite).[`onwheel`](/pixi-vn-json/docs-entry/interfaces/ImageSprite#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-63]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`origin`](/pixi-vn-json/docs-entry/interfaces/TextOptions#origin)

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-64]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`parent`](/pixi-vn-json/docs-entry/interfaces/TextOptions#parent)

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-65]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`percentagePosition`](/pixi-vn-json/docs-entry/interfaces/TextOptions#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-66]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`percentageX`](/pixi-vn-json/docs-entry/interfaces/TextOptions#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`percentageY`](/pixi-vn-json/docs-entry/interfaces/TextOptions#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-68]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`pivot`](/pixi-vn-json/docs-entry/interfaces/TextOptions#pivot)

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-69]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`position`](/pixi-vn-json/docs-entry/interfaces/TextOptions#position)

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-51]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-70]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`renderable`](/pixi-vn-json/docs-entry/interfaces/TextOptions#renderable)

***

### resolution? [#resolution]

> `optional` **resolution?**: `number`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:175

The resolution/device pixel ratio for rendering.
Higher values result in sharper text at the cost of performance.
Set to null for auto-resolution based on device.

#### Example [#example-60]

```ts
const text = new Text({
    text: 'Hello Pixi!',
    resolution: 2 // High DPI for sharper text
});
const autoResText = new Text({
    text: 'Auto Resolution',
    resolution: null // Use device's pixel ratio
});
```

#### Default [#default-52]

```ts
null
```

#### Inherited from [#inherited-from-71]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`resolution`](/pixi-vn-json/docs-entry/interfaces/TextOptions#resolution)

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-72]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`rotation`](/pixi-vn-json/docs-entry/interfaces/TextOptions#rotation)

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:225

Whether to round the x/y position to whole pixels.
Enabling can prevent anti-aliasing of text edges but may cause slight position shifting.

#### Example [#example-62]

````ts
const text = new Text({
    text: 'Rounded Text',
    roundPixels: true // Rounds position to whole pixels
});
@default false

#### Inherited from

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`roundPixels`](/pixi-vn-json/docs-entry/interfaces/TextOptions#roundpixels)

***

### scale?

&gt; `optional` **scale?**: `number` \| `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
````

#### Inherited from [#inherited-from-73]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`scale`](/pixi-vn-json/docs-entry/interfaces/TextOptions#scale)

***

### setMask? [#setmask]

\> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-74]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`setMask`](/pixi-vn-json/docs-entry/interfaces/TextOptions#setmask)

***

### skew? [#skew]

\> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-63]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-53]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-75]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`skew`](/pixi-vn-json/docs-entry/interfaces/TextOptions#skew)

***

### sortableChildren? [#sortablechildren]

\> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-64]

```ts
container.sortableChildren = true;
```

#### Default [#default-54]

```ts
false
```

#### Inherited from [#inherited-from-76]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`sortableChildren`](/pixi-vn-json/docs-entry/interfaces/TextOptions#sortablechildren)

***

### sortDirty? [#sortdirty]

\> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-55]

```ts
false
@internal
```

#### Inherited from [#inherited-from-77]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`sortDirty`](/pixi-vn-json/docs-entry/interfaces/TextOptions#sortdirty)

***

### style? [#style]

\> `optional` **style?**: `TextStyle` | `TextStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:213

The style configuration for the text.
Can be a TextStyle instance or a configuration object.
Supports canvas text styles, HTML text styles, and bitmap text styles.

#### Example [#example-65]

````ts
const text = new Text({
    text: 'Styled Text',
    style: {
        fontSize: 24,
        fill: 0xff1010, // Red color
        fontFamily: 'Arial',
        align: 'center', // Center alignment
        stroke: { color: '#4a1850', width: 5 }, // Purple stroke
        dropShadow: {
            color: '#000000', // Black shadow
            blur: 4, // Shadow blur
            distance: 6 // Shadow distance
        }
    }
});
const htmlText = new HTMLText({
    text: 'HTML Styled Text',
    style: {
        fontSize: '20px',
        fill: 'blue',
        fontFamily: 'Verdana',
    }
});
const bitmapText = new BitmapText({
    text: 'Bitmap Styled Text',
    style: {
        fontName: 'Arial',
        fontSize: 32,
    }
})

#### Inherited from

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`style`](/pixi-vn-json/docs-entry/interfaces/TextOptions#style)

***

### tabIndex?

> `optional` **tabIndex?**: `number`

Defined in: node\_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default

```ts
0
````

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-78]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`tabIndex`](/pixi-vn-json/docs-entry/interfaces/TextOptions#tabindex)

***

### text? [#text]

> `optional` **text?**: `TextString`

Defined in: node_modules/pixi.js/lib/scene/text/AbstractText.d.ts:157

The text content to display. Use '\n' for line breaks.
Accepts strings, numbers, or objects with toString() method.

#### Example [#example-67]

```ts
const text = new Text({
    text: 'Hello Pixi!',
});
const multilineText = new Text({
    text: 'Line 1\nLine 2\nLine 3',
});
const numberText = new Text({
    text: 12345, // Will be converted to '12345'
});
const objectText = new Text({
    text: { toString: () =&gt; 'Object Text' }, // Custom toString
});
```

#### Default [#default-56]

```ts
''
```

#### Inherited from [#inherited-from-79]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`text`](/pixi-vn-json/docs-entry/interfaces/TextOptions#text)

***

### textureStyle? [#texturestyle]

> `optional` **textureStyle?**: `TextureStyle` | `TextureStyleOptions`

Defined in: node_modules/pixi.js/lib/scene/text/Text.d.ts:62

Optional texture style to use for the text texture. This allows fine control over
how the text is rendered to a texture before being displayed.

The texture style can affect:

* Scale mode (nearest/linear)
* Resolution
* Format (rgb/rgba)
* Alpha handling

#### Example [#example-68]

```ts
const text = new Text({
    text: 'Crisp Text',
    textureStyle: {
        scaleMode: 'nearest', // Pixel-perfect scaling
    }
});
```

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-80]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`textureStyle`](/pixi-vn-json/docs-entry/interfaces/TextOptions#texturestyle)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-69]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-81]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`tint`](/pixi-vn-json/docs-entry/interfaces/TextOptions#tint)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-70]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-82]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`visible`](/pixi-vn-json/docs-entry/interfaces/TextOptions#visible)

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-71]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-83]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`width`](/pixi-vn-json/docs-entry/interfaces/TextOptions#width)

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-72]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-84]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`x`](/pixi-vn-json/docs-entry/interfaces/TextOptions#x)

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-85]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`xAlign`](/pixi-vn-json/docs-entry/interfaces/TextOptions#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-73]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-86]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`y`](/pixi-vn-json/docs-entry/interfaces/TextOptions#y)

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-87]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`yAlign`](/pixi-vn-json/docs-entry/interfaces/TextOptions#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-74]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-json/docs-entry/interfaces/ImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-88]

[`TextOptions`](/pixi-vn-json/docs-entry/interfaces/TextOptions).[`zIndex`](/pixi-vn-json/docs-entry/interfaces/TextOptions#zindex)


# Interface: PixiVNJsonIfElse<Then> (/pixi-vn-json/index/interfaces/PixiVNJsonIfElse)



Defined in: [src/schema/PixiVNJsonIfElse.ts:8](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonIfElse.ts#L8)

If-Else condition for PixiVNJson

## Type Parameters [#type-parameters]

### Then [#then]

`Then`

## Properties [#properties]

### condition [#condition]

\> **condition**: [`PixiVNJsonConditions`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)

Defined in: [src/schema/PixiVNJsonIfElse.ts:20](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonIfElse.ts#L20)

The list of conditions to be checked.

if is a StorageElementType or a [PixiVNJsonValueGet](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet):

* if is a array or object, the condition is true if not empty
* if is a string, the condition is true if not empty
* if is a number, the condition is true if not zero
* if is a boolean, the condition is true if true
* if is null or undefined, the condition is false

***

### else? [#else]

\> `optional` **else?**: `PixiVNJsonIfElse`\<`Then`> | `Then`

Defined in: [src/schema/PixiVNJsonIfElse.ts:28](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonIfElse.ts#L28)

The value to be returned if the condition is false.

***

### then [#then-1]

\> **then**: `PixiVNJsonIfElse`\<`Then`> | `Then`

Defined in: [src/schema/PixiVNJsonIfElse.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonIfElse.ts#L24)

The value to be returned if the condition is true.

***

### type [#type]

\> **type**: `"ifelse"`

Defined in: [src/schema/PixiVNJsonIfElse.ts:9](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonIfElse.ts#L9)


# Interface: PixiVNJsonSoundEditProps (/pixi-vn-json/index/interfaces/PixiVNJsonSoundEditProps)



Defined in: [src/schema/PixiVNJsonSound.ts:56](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L56)

Partial set of sound properties that can be applied when editing a currently playing sound.

## Extends [#extends]

* `Partial`\<`Pick`\<[`MediaInterface`](/pixi-vn-json/docs-entry/interfaces/MediaInterface), `"speed"` | `"muted"` | `"loop"` | `"paused"`>>.`Partial`\<`Pick`\<[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel), `"volume"`>>

## Properties [#properties]

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:163

#### Inherited from [#inherited-from]

`Partial.loop`

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:11

#### Deprecated [#deprecated]

Use [mute](/pixi-vn-json/docs-entry/interfaces/MediaInterface#mute) instead.

#### Inherited from [#inherited-from-1]

[`MediaInterface`](/pixi-vn-json/docs-entry/interfaces/MediaInterface).[`muted`](/pixi-vn-json/docs-entry/interfaces/MediaInterface#muted)

***

### paused? [#paused]

\> `optional` **paused?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:7

Whether the sound is currently paused.

#### Inherited from [#inherited-from-2]

[`MediaInterface`](/pixi-vn-json/docs-entry/interfaces/MediaInterface).[`paused`](/pixi-vn-json/docs-entry/interfaces/MediaInterface#paused)

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:15

#### Deprecated [#deprecated-1]

Use [playbackRate](/pixi-vn-json/docs-entry/interfaces/MediaInterface#playbackrate) instead.

#### Inherited from [#inherited-from-3]

[`MediaInterface`](/pixi-vn-json/docs-entry/interfaces/MediaInterface).[`speed`](/pixi-vn-json/docs-entry/interfaces/MediaInterface#speed)

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:35

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-4]

[`PixiVNJsonSoundPlayProps`](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps).[`volume`](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps#volume)


# Interface: PixiVNJsonSoundPlayProps (/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps)



Defined in: [src/schema/PixiVNJsonSound.ts:6](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L6)

Playback options such as volume, loop, channel, and start offset.

## Extends [#extends]

* [`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

#### Inherited from [#inherited-from]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`autostart`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#autostart)

***

### channel? [#channel]

\> `optional` **channel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:76

The alias of the audio channel to play the sound on. If the channel does
not exist it will be created automatically.
Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").

#### Inherited from [#inherited-from-1]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`channel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#channel)

***

### delay? [#delay]

\> `optional` **delay?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:64

The delay in seconds before playback starts. If specified, playback is
scheduled to begin after the delay has elapsed rather than starting
immediately in a paused state.

#### Inherited from [#inherited-from-2]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`delay`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#delay)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:68

The offset in seconds from the start of the sound at which to begin playback.

#### Inherited from [#inherited-from-3]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#elapsed)

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

#### Inherited from [#inherited-from-4]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`fadeIn`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#fadein)

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

#### Inherited from [#inherited-from-5]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`fadeOut`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#fadeout)

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:48

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

#### Example [#example]

```ts
import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];
```

#### Inherited from [#inherited-from-6]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`filters`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#filters)

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

#### Inherited from [#inherited-from-7]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`loop`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#loop)

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

#### Inherited from [#inherited-from-8]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`loopEnd`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#loopend)

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

#### Inherited from [#inherited-from-9]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`loopStart`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#loopstart)

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

#### Inherited from [#inherited-from-10]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`mute`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#mute)

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:56

#### Deprecated [#deprecated]

Use [mute](#mute) instead.

#### Inherited from [#inherited-from-11]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`muted`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#muted)

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

#### Inherited from [#inherited-from-12]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`playbackRate`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#playbackrate)

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

#### Inherited from [#inherited-from-13]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`reverse`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#reverse)

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:52

#### Deprecated [#deprecated-1]

Use [playbackRate](#playbackrate) instead.

#### Inherited from [#inherited-from-14]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`speed`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#speed)

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:35

The volume of this sound in the linear range \[0, 1], where 0 is silence
and 1 is full volume.  This is converted to decibels internally before
being passed to the Tone.js Player.

#### Inherited from [#inherited-from-15]

[`SoundPlayOptionsWithChannel`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel).[`volume`](/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel#volume)


# Interface: PushInOutTransitionProps (/pixi-vn-json/index/interfaces/PushInOutTransitionProps)



Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:89](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L89)

Configuration options for the push transition (direction, duration, easing, etc.).

## Extends [#extends]

* [`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`aliasToRemoveAfter`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#aliastoremoveafter)

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`autoplay`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`bounce`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`bounceDamping`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`bounceStiffness`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`completeOnContinue`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`damping`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`delay`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`delayChildren`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1687

The direction of the push effect.

#### Default [#default-3]

```ts
"right"
```

#### Inherited from [#inherited-from-9]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`direction`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#direction)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-10]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`driver`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`duration`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-12]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`ease`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-14]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`from`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`inherit`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-16]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`isSync`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`mass`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`max`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`min`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`modifyTarget`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`path`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`power`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`reduceMotion`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`restDelta`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`restSpeed`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`skipAnimations`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`staggerChildren`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`staggerDirection`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-32]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`startTime`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`stiffness`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`tickerAliasToResume`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#tickeraliastoresume)

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-35]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`tickerIdToResume`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#tickeridtoresume)

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`timeConstant`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-37]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`times`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`type`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-39]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`velocity`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`visualDuration`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`PushInOutProps`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps).[`when`](/pixi-vn-json/docs-entry/interfaces/PushInOutProps#when)


# Interface: ZoomInOutTransitionProps (/pixi-vn-json/index/interfaces/ZoomInOutTransitionProps)



Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:70](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L70)

Configuration options for the zoom transition (scale, duration, easing, etc.).

## Extends [#extends]

* [`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`aliasToRemoveAfter`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#aliastoremoveafter)

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2212

#### Inherited from [#inherited-from-1]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`autoplay`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#autoplay)

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2035

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`bounce`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#bounce)

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2109

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`bounceDamping`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#bouncedamping)

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2101

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`bounceStiffness`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#bouncestiffness)

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1662

If true, the transition will be completed before the next step.
For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-5]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`completeOnContinue`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#completeoncontinue)

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2055

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`damping`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#damping)

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2343

#### Inherited from [#inherited-from-7]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`delay`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#delay)

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2151

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`delayChildren`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#delaychildren)

***

### direction? [#direction]

\> `optional` **direction?**: `"left"` | `"right"` | `"up"` | `"down"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:1680

The direction of the zoom effect.

#### Default [#default-3]

```ts
"right"
```

#### Inherited from [#inherited-from-9]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`direction`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#direction)

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2197

#### Inherited from [#inherited-from-10]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`driver`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#driver)

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2211

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-11]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`duration`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#duration)

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2182

#### Inherited from [#inherited-from-12]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`ease`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#ease)

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2196

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-13]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`elapsed`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#elapsed)

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2214

#### Inherited from [#inherited-from-14]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`from`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#from)

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2221

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-15]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`inherit`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#inherit)

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:1955

#### Inherited from [#inherited-from-16]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`isSync`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#issync)

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2064

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-4]

```ts
1

@public
```

#### Inherited from [#inherited-from-17]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`mass`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#mass)

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2121

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-18]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`max`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#max)

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2115

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-19]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`min`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#min)

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2091

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters]

##### v [#v]

`number`

#### Returns [#returns]

`number`

#### Inherited from [#inherited-from-20]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`modifyTarget`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#modifytarget)

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2240

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-21]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`path`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#path)

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2078

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-22]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`power`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#power)

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2353

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-23]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`reduceMotion`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#reducemotion)

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1966

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-24]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1985

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:1978

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-26]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2003

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-27]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`restDelta`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#restdelta)

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1995

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-28]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`restSpeed`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#restspeed)

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2229

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-29]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`skipAnimations`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#skipanimations)

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2164

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-30]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`staggerChildren`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#staggerchildren)

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2173

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-31]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`staggerDirection`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#staggerdirection)

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2213

#### Inherited from [#inherited-from-32]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`startTime`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#starttime)

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2046

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-5]

```ts
100

@public
```

#### Inherited from [#inherited-from-33]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`stiffness`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#stiffness)

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-34]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`tickerAliasToResume`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#tickeraliastoresume)

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-7]

```ts
[]
```

#### Inherited from [#inherited-from-35]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`tickerIdToResume`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#tickeridtoresume)

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2085

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-36]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`timeConstant`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#timeconstant)

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2183

#### Inherited from [#inherited-from-37]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`times`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#times)

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2205

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-38]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`type`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#type)

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:1988

#### Inherited from [#inherited-from-39]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`velocity`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#velocity)

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2023

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-40]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`visualDuration`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#visualduration)

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2142

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-41]

[`ZoomInOutProps`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps).[`when`](/pixi-vn-json/docs-entry/interfaces/ZoomInOutProps#when)


# Function: add() (/pixi-vn-json/index/namespaces/TextReplaces/functions/add)



\> **add**(`fn`, `handlerOptions`): `void`

Defined in: [src/translator/TextReplaces.ts:79](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L79)

Registers a new replacement handler.

Handlers are executed in the order they are added. The first handler added runs first.

The TranslatorManager translation pipeline automatically calls
[TextReplaces.replace](/pixi-vn-json/index/namespaces/TextReplaces/functions/replace) for both phases (`"before-translation"` and
`"after-translation"`), so no additional setup is required after calling `add`.

## Parameters [#parameters]

### fn [#fn]

[`ReplaceHandler`](/pixi-vn-json/index/type-aliases/ReplaceHandler)

The handler function. Receives the key found inside `[...]` and should return
the replacement string, or `undefined` to leave that token unchanged.

### handlerOptions [#handleroptions]

[`ReplaceHandlerOptions`](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions)

Configuration for this handler, including its name, optional
description, validation regex, and execution phase.

## Returns [#returns]

`void`

## Example [#example]

```ts title="content/text-replaces.ts"
import { TextReplaces } from 'pixi-vn-ink'

TextReplaces.add(
    (key) => key === "player" ? "Mario" : undefined,
    {
        name: "player-name",
        validation: /^player$/,
    }
)
```


# Function: info() (/pixi-vn-json/index/namespaces/TextReplaces/functions/info)



\> **info**(): [`ReplaceHandlerOptions`](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions)\[]

Defined in: [src/translator/TextReplaces.ts:103](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L103)

Returns metadata for all registered handlers, in registration order.

## Returns [#returns]

[`ReplaceHandlerOptions`](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions)\[]

An array of [ReplaceHandlerOptions](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions) for each registered handler.


# Function: remove() (/pixi-vn-json/index/namespaces/TextReplaces/functions/remove)



\> **remove**(`fn`): `void`

Defined in: [src/translator/TextReplaces.ts:91](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L91)

Removes a previously registered handler function.

Only the first registration matching `fn` is removed. If the same function was added
multiple times, subsequent registrations remain.

## Parameters [#parameters]

### fn [#fn]

[`ReplaceHandler`](/pixi-vn-json/index/type-aliases/ReplaceHandler)

The handler function to remove.

## Returns [#returns]

`void`


# Function: replace() (/pixi-vn-json/index/namespaces/TextReplaces/functions/replace)



\> **replace**(`text`, `replaceOptions`): `string`

Defined in: [src/translator/TextReplaces.ts:125](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L125)

Applica tutti gli handler registrati del tipo specificato al testo dato.

Questa funzione NON esegue più la pre-elaborazione i18n automaticamente.
Se vuoi applicare la pre-elaborazione i18n, usa prima [runI18nPreStep](/pixi-vn-json/index/namespaces/TextReplaces/functions/runI18nPreStep) sul testo.

## Parameters [#parameters]

### text [#text]

`string`

Il testo sorgente da processare.

### replaceOptions [#replaceoptions]

Specifica quale fase di handler eseguire.

#### type [#type]

`"after-translation"` | `"before-translation"`

Quale fase di handler eseguire.

## Returns [#returns]

`string`

Il testo dopo che tutti gli handler sono stati applicati.

## Example [#example]

```ts
// Solo handler di tipo "before-translation"
TextReplaces.replace("Ciao [name]", { type: "before-translation" })

// Con pre-elaborazione i18n:
let t = TextReplaces.runI18nPreStep("Ciao [name]");
t = TextReplaces.replace(t, { type: "before-translation" });
```


# Function: runI18nPreStep() (/pixi-vn-json/index/namespaces/TextReplaces/functions/runI18nPreStep)



\> **runI18nPreStep**(`text`): `string`

Defined in: [src/translator/TextReplaces.ts:153](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L153)

Esegue la pre-elaborazione i18n su tutti gli handler registrati con `i18nInterpolation: true`.

Per ogni handler con questa opzione, la prima occorrenza di ogni `[key]` valida viene sostituita con `{{[key]}}`.

## Parameters [#parameters]

### text [#text]

`string`

Il testo da processare.

## Returns [#returns]

`string`

Il testo dopo la pre-elaborazione i18n.

## Example [#example]

```ts
// Pre-elabora tutte le variabili i18n:
const pre = TextReplaces.runI18nPreStep("Ciao [name]");
```


# TextReplaces (/pixi-vn-json/index/namespaces/TextReplaces)



Manages text replacement handlers that process content enclosed in square brackets (`[key]`).

Handlers are called in the order they were added. For each handler, the current text is scanned
for all `[key]` patterns. If the handler's `validation` matches a key, the handler is
invoked with that key. If the handler returns a string, all occurrences of `[key]` are replaced
with the returned value. After a handler finishes processing the text, the next handler starts
on the updated text.

Each handler specifies whether it runs before or after translation via the `type` field in its
options (defaults to `"after-translation"`).

## Example [#example]

```ts title="content/text-replaces.ts"
import { TextReplaces } from 'pixi-vn-ink'
import { getCharacterById } from "@drincs/pixi-vn";

// Replace [characterId] with the character's display name
TextReplaces.add(
    (key) => {
        const character = getCharacterById(key)
        return character?.name
    },
    {
        name: "character-name",
        description: "Replaces character IDs with their display names",
        validation: /^[a-z_]+$/,
        type: "after-translation",
    }
)
// "Hello [john], meet [jane]!" -> "Hello John, meet Jane!"
```

## Variables [#variables]

* [options](/pixi-vn-json/index/namespaces/TextReplaces/variables/options)

## Functions [#functions]

* [add](/pixi-vn-json/index/namespaces/TextReplaces/functions/add)
* [info](/pixi-vn-json/index/namespaces/TextReplaces/functions/info)
* [remove](/pixi-vn-json/index/namespaces/TextReplaces/functions/remove)
* [replace](/pixi-vn-json/index/namespaces/TextReplaces/functions/replace)
* [runI18nPreStep](/pixi-vn-json/index/namespaces/TextReplaces/functions/runI18nPreStep)


# Variable: options (/pixi-vn-json/index/namespaces/TextReplaces/variables/options)



\> `const` **options**: `object`

Defined in: [src/translator/TextReplaces.ts:42](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TextReplaces.ts#L42)

Configuration options for the `TextReplaces` system.

## Type Declaration [#type-declaration]

### replaceRegex [#replaceregex]

\> **replaceRegex**: `RegExp`

The regex used to find replacement tokens in the text (e.g. `[key]`).

#### Default [#default]

```ts
/\[([^\]]+)\]/
```


# Function: add() (/pixi-vn-json/index/namespaces/VariableGetter/functions/add)



\> **add**(`handler`): `void`

Defined in: [src/actions/VariableGetter.ts:17](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/actions/VariableGetter.ts#L17)

Registers a new middleware handler into the resolution chain.
Handlers are invoked in the order they were added.

## Parameters [#parameters]

### handler [#handler]

[`VariableGetterHandler`](/pixi-vn-json/index/type-aliases/VariableGetterHandler)

The middleware handler to register.

## Returns [#returns]

`void`


# Function: clear() (/pixi-vn-json/index/namespaces/VariableGetter/functions/clear)



\> **clear**(): `void`

Defined in: [src/actions/VariableGetter.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/actions/VariableGetter.ts#L24)

Removes all registered middleware handlers, restoring the default resolution behaviour.

## Returns [#returns]

`void`


# Function: getLogichValue() (/pixi-vn-json/index/namespaces/VariableGetter/functions/getLogichValue)



\> **getLogichValue**\<`T`>(`value`, `props?`): `T` | `undefined`

Defined in: [src/actions/VariableGetter.ts:36](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/actions/VariableGetter.ts#L36)

Resolves a JSON logic value, running it through all registered middleware handlers
before falling back to the built-in storage/arithmetic/condition evaluator.

## Type Parameters [#type-parameters]

### T [#t]

`T` = `StorageElementType`

## Parameters [#parameters]

### value [#value]

`any`

The value or logic expression to resolve.

### props? [#props]

`StepLabelProps` = `{}`

The current step label props passed to each handler.

## Returns [#returns]

`T` | `undefined`

The resolved value, or `undefined`.


# VariableGetter (/pixi-vn-json/index/namespaces/VariableGetter)



## Functions [#functions]

* [add](/pixi-vn-json/index/namespaces/VariableGetter/functions/add)
* [clear](/pixi-vn-json/index/namespaces/VariableGetter/functions/clear)
* [getLogichValue](/pixi-vn-json/index/namespaces/VariableGetter/functions/getLogichValue)


# Function: generateJsonTranslation() (/pixi-vn-json/index/namespaces/translator/functions/generateJsonTranslation)



\> **generateJsonTranslation**(`labels`, `json?`, `options?`): `Promise`\<`object`>

Defined in: [src/translator/TranslatorManager.ts:195](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L195)

Generates a JSON translation object from the provided labels.

## Parameters [#parameters]

### labels [#labels]

[`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)\[]

The labels to translate.

### json? [#json]

`object` = `{}`

The JSON object to populate with translations.

### options? [#options]

Options for translation, including default value handling.

#### defaultValue? [#defaultvalue]

`"empty_string"` | `"copy_key"`

Default value to use when a key is not found.

* "empty_string": Use an empty string as the default value.
* "copy_key": Use the key itself as the default value.

**Default**

```ts
"copy_key"
```

#### operationStringConvert? [#operationstringconvert]

(`value`, `step`, `props`) => `Promise`\<[`PixiVNJsonOperation`](/pixi-vn-json/index/type-aliases/PixiVNJsonOperation) | `undefined`>

## Returns [#returns]

`Promise`\<`object`>

The populated JSON object with translations.


# Function: setTranslate() (/pixi-vn-json/index/namespaces/translator/functions/setTranslate)



\> **setTranslate**(`value`): `void`

Defined in: [src/translator/TranslatorManager.ts:91](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L91)

Sets the main translation function.
Defaults to an identity function (returns the key unchanged).

## Parameters [#parameters]

### value [#value]

(`key`) => `string`

## Returns [#returns]

`void`

## Example [#example]

```ts
setTranslate((key) => i18n.t(key));
```


# Function: t() (/pixi-vn-json/index/namespaces/translator/functions/t)



\> **t**\<`T`>(`key`): `T`

Defined in: [src/translator/TranslatorManager.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L53)

Translates a single key or an array of keys using the registered pipeline.
Returns the same type (`string` or `string[]`) as the input.

## Type Parameters [#type-parameters]

### T [#t]

`T` = `string` | `string`\[]

## Parameters [#parameters]

### key [#key]

`T`

The string key or array of string keys to translate.

## Returns [#returns]

`T`

The translated string(s).


# Function: translate() (/pixi-vn-json/index/namespaces/translator/functions/translate)



\> **translate**(`key`): `string`

Defined in: [src/translator/TranslatorManager.ts:68](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L68)

Runs the composed translation pipeline:

1. optional `beforeToTranslate` hook (deprecated)
2. [TextReplaces.replace](/pixi-vn-json/index/namespaces/TextReplaces/functions/replace) – before-translation phase
3. main `translate` function
4. optional `afterToTranslate` hook (deprecated)
5. [TextReplaces.replace](/pixi-vn-json/index/namespaces/TextReplaces/functions/replace) – after-translation phase

## Parameters [#parameters]

### key [#key]

`string`

## Returns [#returns]

`string`


# translator (/pixi-vn-json/index/namespaces/translator)



Manages the translation pipeline for all text displayed by pixi-vn-json.

The pipeline applies three optional hooks in order:

1. `beforeToTranslate` – pre-processes the key before translation.
2. `translate` – the main translation function (identity by default).
3. `afterToTranslate` – post-processes the translated string.

Use [TranslatorManager.t](/pixi-vn-json/index/namespaces/translator/functions/t) to translate a key or array of keys.

## Variables [#variables]

* [~~afterToTranslate~~](/pixi-vn-json/index/namespaces/translator/variables/afterToTranslate)
* [~~beforeToTranslate~~](/pixi-vn-json/index/namespaces/translator/variables/beforeToTranslate)

## Functions [#functions]

* [generateJsonTranslation](/pixi-vn-json/index/namespaces/translator/functions/generateJsonTranslation)
* [setTranslate](/pixi-vn-json/index/namespaces/translator/functions/setTranslate)
* [t](/pixi-vn-json/index/namespaces/translator/functions/t)
* [translate](/pixi-vn-json/index/namespaces/translator/functions/translate)


# Variable: afterToTranslate (deprecated) (/pixi-vn-json/index/namespaces/translator/variables/afterToTranslate)



\> **afterToTranslate**: ((`key`) => `string`) | `undefined`

Defined in: [src/translator/TranslatorManager.ts:44](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L44)

## Deprecated [#deprecated]

Optional hook that runs **after** the built-in [TextReplaces](/pixi-vn-json/index/namespaces/TextReplaces) after-translation
replace pass. Useful for post-processing translated strings.

Prefer [TextReplaces.add](/pixi-vn-json/index/namespaces/TextReplaces/functions/add) with `type: "after-translation"` instead.


# Variable: beforeToTranslate (deprecated) (/pixi-vn-json/index/namespaces/translator/variables/beforeToTranslate)



\> **beforeToTranslate**: ((`key`) => `string`) | `undefined`

Defined in: [src/translator/TranslatorManager.ts:35](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/TranslatorManager.ts#L35)

## Deprecated [#deprecated]

Optional hook that runs **before** the built-in [TextReplaces](/pixi-vn-json/index/namespaces/TextReplaces) before-translation
replace pass. Useful for key normalization (e.g. trimming, lowercasing).

Prefer [TextReplaces.add](/pixi-vn-json/index/namespaces/TextReplaces/functions/add) with `type: "before-translation"` instead.


# Type Alias: DissolveTransition (/pixi-vn-json/index/type-aliases/DissolveTransition)



\> **DissolveTransition** = `object`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:17](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L17)

Cross-dissolve transition — blends the element in or out by gradually changing its opacity.

## Properties [#properties]

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:26](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L26)

Pixi.js update priority for the transition ticker callback.

***

### props? [#props]

\> `optional` **props?**: [`DissolveTransitionProps`](/pixi-vn-json/index/interfaces/DissolveTransitionProps)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:22](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L22)

Configuration options for the dissolve transition.

***

### type [#type]

\> **type**: `"dissolve"`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:18](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L18)


# Type Alias: FadeTransition (/pixi-vn-json/index/type-aliases/FadeTransition)



\> **FadeTransition** = `object`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:36](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L36)

Fade transition — fades the element in or out by animating its alpha value.

## Properties [#properties]

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:45](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L45)

Pixi.js update priority for the transition ticker callback.

***

### props? [#props]

\> `optional` **props?**: [`FadeTransitionProps`](/pixi-vn-json/index/interfaces/FadeTransitionProps)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:41](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L41)

Configuration options for the fade transition.

***

### type [#type]

\> **type**: `"fade"`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:37](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L37)


# Type Alias: MoveInOutTransition (/pixi-vn-json/index/type-aliases/MoveInOutTransition)



\> **MoveInOutTransition** = `object`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:55](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L55)

Move-in / Move-out transition — slides the element into or out of the viewport.

## Properties [#properties]

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:64](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L64)

Pixi.js update priority for the transition ticker callback.

***

### props? [#props]

\> `optional` **props?**: [`MoveInOutTransitionProps`](/pixi-vn-json/index/interfaces/MoveInOutTransitionProps)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:60](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L60)

Configuration options for the move transition (direction, duration, easing, etc.).

***

### type [#type]

\> **type**: `"movein"` | `"moveout"`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:56](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L56)


# Type Alias: PixiVNJsonAnimateBase<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateBase)



\> **PixiVNJsonAnimateBase**\<`T`> = `object`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:18](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L18)

Animates one or more canvas elements simultaneously using keyframe-based animation.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `CanvasBaseInterface`\<`any`>

## Properties [#properties]

### alias [#alias]

\> **alias**: `string` | `string`\[]

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L23)

Alias (or list of aliases) of the canvas elements to animate.

***

### keyframes [#keyframes]

\> **keyframes**: `KeyframesType`\<`T`>

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:27](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L27)

The keyframes that define the animation values over time.

***

### options? [#options]

\> `optional` **options?**: [`PixiVNJsonAnimateBaseOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateBaseOptions)

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:31](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L31)

Additional options controlling the animation (duration, easing, repeat, etc.).

***

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:35](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L35)

Pixi.js update priority for this animation ticker callback.

***

### type [#type]

\> **type**: `"animate"`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:19](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L19)


# Type Alias: PixiVNJsonAnimateSequence<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateSequence)



\> **PixiVNJsonAnimateSequence**\<`T`> = `object`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:44](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L44)

Animates a canvas element using a sequence of segments (timeline-based animation).

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `CanvasBaseInterface`\<`any`>

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:49](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L49)

Alias of the canvas element to animate.

***

### options? [#options]

\> `optional` **options?**: [`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions)

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:57](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L57)

Additional options controlling the sequence playback.

***

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:61](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L61)

Pixi.js update priority for this animation ticker callback.

***

### sequence [#sequence]

\> **sequence**: (`ObjectSegment`\<`T`> | `ObjectSegmentWithTransition`\<`T`>)\[]

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L53)

Ordered list of animation segments, each optionally including a transition.

***

### type [#type]

\> **type**: `"animate-sequence"`

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:45](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L45)


# Type Alias: PixiVNJsonArithmeticOperations (/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations)



\> **PixiVNJsonArithmeticOperations** = [`PixiVNJsonArithmeticOperationsArithmeticSingle`](/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmeticSingle) | [`PixiVNJsonArithmeticOperationsArithmetic`](/pixi-vn-json/index/interfaces/PixiVNJsonArithmeticOperationsArithmetic)

Defined in: [src/schema/PixiVNJsonArithmeticOperations.ts:71](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonArithmeticOperations.ts#L71)

Arithmetic operations for the PixiVNJson


# Type Alias: PixiVNJsonCanvas (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvas)



\> **PixiVNJsonCanvas** = [`PixiVNJsonCanvasShow`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasShow) | [`PixiVNJsonCanvasEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEdit) | [`PixiVNJsonCanvasRemove`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasRemove) | [`PixiVNJsonCanvasClear`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasClear) | [`PixiVNJsonVideoPauseResume`](/pixi-vn-json/index/type-aliases/PixiVNJsonVideoPauseResume) | `PixiVNJsonAssetsLoad` | [`PixiVNJsonCanvasAnimate`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasAnimate) | [`PixiVNJsonCanvasEffect`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEffect)

Defined in: [src/schema/PixiVNJsonCanvas.ts:239](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L239)

Union of all canvas operations — show, edit, remove, clear, animate, apply effects, and asset
loading.


# Type Alias: PixiVNJsonCanvasAnimate<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasAnimate)



\> **PixiVNJsonCanvasAnimate**\<`T`> = [`PixiVNJsonAnimateBase`](/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateBase)\<`T`> | [`PixiVNJsonAnimateSequence`](/pixi-vn-json/index/type-aliases/PixiVNJsonAnimateSequence)\<`T`>

Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:67](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasAnimate.ts#L67)

Union of all canvas animation operations — keyframe-based or sequence-based.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `CanvasBaseInterface`\<`any`> = [`ImageSprite`](/pixi-vn-json/docs-entry/interfaces/ImageSprite)


# Type Alias: PixiVNJsonCanvasClear (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasClear)



\> **PixiVNJsonCanvasClear** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:194](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L194)

Removes every element currently on the canvas.

## Properties [#properties]

### operationType [#operationtype]

\> **operationType**: `"clear"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:196](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L196)

***

### type [#type]

\> **type**: `"canvas"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:195](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L195)


# Type Alias: PixiVNJsonCanvasEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEdit)



\> **PixiVNJsonCanvasEdit** = [`PixiVNJsonImageEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonImageEdit) | [`PixiVNJsonVideoEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonVideoEdit) | [`PixiVNJsonImageContainerEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonImageContainerEdit) | [`PixiVNJsonTextEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonTextEdit) | [`PixiVNJsonUnknownEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonUnknownEdit)\<`ImageSpriteMemory` | `VideoSpriteMemory` | `ContainerMemory` | `TextMemory`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:228](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L228)

Union of all canvas-element edit operations.


# Type Alias: PixiVNJsonCanvasEffect (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasEffect)



\> **PixiVNJsonCanvasEffect** = `PixiVNJsonEffectShake`

Defined in: [src/schema/PixiVNJsonCanvasEffect.ts:26](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvasEffect.ts#L26)

Union of all canvas visual effects.


# Type Alias: PixiVNJsonCanvasImageContainerShow (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageContainerShow)



\> **PixiVNJsonCanvasImageContainerShow** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L53)

Shows an image container (a group of layered images) on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:59](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L59)

Unique identifier (alias) used to reference this element on the canvas.

***

### operationType [#operationtype]

\> **operationType**: `"show"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:55](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L55)

***

### props? [#props]

\> `optional` **props?**: [`PixiVNJsonCanvasImageContainerShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageContainerShowProps)

Defined in: [src/schema/PixiVNJsonCanvas.ts:67](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L67)

Display options for the image container.

***

### transition? [#transition]

\> `optional` **transition?**: [`PixiVNJsonMediaTransiotions`](/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)

Defined in: [src/schema/PixiVNJsonCanvas.ts:71](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L71)

Optional transition effect applied when the element appears on screen.

***

### type [#type]

\> **type**: `"imagecontainer"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:54](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L54)

***

### urls [#urls]

\> **urls**: `string`\[]

Defined in: [src/schema/PixiVNJsonCanvas.ts:63](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L63)

The ordered list of image URLs that compose the container layers.


# Type Alias: PixiVNJsonCanvasImageVideoShow (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageVideoShow)



\> **PixiVNJsonCanvasImageVideoShow** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L24)

Shows an image or video asset on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:30](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L30)

Unique identifier (alias) used to reference this element on the canvas.

***

### operationType [#operationtype]

\> **operationType**: `"show"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:26](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L26)

***

### props? [#props]

\> `optional` **props?**: [`PixiVNJsonCanvasImageVideoShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasImageVideoShowProps)

Defined in: [src/schema/PixiVNJsonCanvas.ts:39](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L39)

Display options (position, scale, alpha, etc.) for the image or video sprite.

***

### transition? [#transition]

\> `optional` **transition?**: [`PixiVNJsonMediaTransiotions`](/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)

Defined in: [src/schema/PixiVNJsonCanvas.ts:43](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L43)

Optional transition effect applied when the element appears on screen.

***

### type [#type]

\> **type**: `"image"` | `"video"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:25](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L25)

***

### url? [#url]

\> `optional` **url?**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:35](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L35)

The url of the image or video.
If the url is not provided, the url will be set to the alias.


# Type Alias: PixiVNJsonCanvasRemove (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasRemove)



\> **PixiVNJsonCanvasRemove** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:179](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L179)

Removes a canvas element from the stage, optionally with a transition.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:185](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L185)

Alias of the canvas element to remove.

***

### operationType [#operationtype]

\> **operationType**: `"remove"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:181](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L181)

***

### transition? [#transition]

\> `optional` **transition?**: [`PixiVNJsonMediaTransiotions`](/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)

Defined in: [src/schema/PixiVNJsonCanvas.ts:189](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L189)

Optional transition effect applied while the element disappears.

***

### type [#type]

\> **type**: `"image"` | `"video"` | `"imagecontainer"` | `"canvaselement"` | `"text"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:180](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L180)


# Type Alias: PixiVNJsonCanvasShow (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasShow)



\> **PixiVNJsonCanvasShow** = [`PixiVNJsonCanvasImageContainerShow`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageContainerShow) | [`PixiVNJsonCanvasImageVideoShow`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasImageVideoShow) | [`PixiVNJsonCanvasTextShow`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasTextShow)

Defined in: [src/schema/PixiVNJsonCanvas.ts:221](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L221)


# Type Alias: PixiVNJsonCanvasTextShow (/pixi-vn-json/index/type-aliases/PixiVNJsonCanvasTextShow)



\> **PixiVNJsonCanvasTextShow** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:80](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L80)

Shows a text element on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:86](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L86)

Unique identifier (alias) used to reference this element on the canvas.

***

### operationType [#operationtype]

\> **operationType**: `"show"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:82](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L82)

***

### props? [#props]

\> `optional` **props?**: [`PixiVNJsonCanvasTextShowProps`](/pixi-vn-json/index/interfaces/PixiVNJsonCanvasTextShowProps)

Defined in: [src/schema/PixiVNJsonCanvas.ts:94](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L94)

Display options (font, style, position, etc.) for the text element.

***

### text [#text]

\> **text**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:90](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L90)

The string content to display.

***

### transition? [#transition]

\> `optional` **transition?**: [`PixiVNJsonMediaTransiotions`](/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)

Defined in: [src/schema/PixiVNJsonCanvas.ts:98](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L98)

Optional transition effect applied when the element appears on screen.

***

### type [#type]

\> **type**: `"text"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:81](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L81)


# Type Alias: PixiVNJsonChoice (/pixi-vn-json/index/type-aliases/PixiVNJsonChoice)



\> **PixiVNJsonChoice** = `object`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:14](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L14)

A player-presentable choice in a menu.

## Properties [#properties]

### autoSelect? [#autoselect]

\> `optional` **autoSelect?**: `boolean`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:42](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L42)

If this is true and if is the only choice, it will be automatically selected, and call/jump to the label.

***

### label [#label]

\> **label**: `string`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:22](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L22)

The label id to be opened.

***

### oneTime? [#onetime]

\> `optional` **oneTime?**: `boolean`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:34](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L34)

If this is true, the choice can only be made once.

***

### onlyHaveNoChoice? [#onlyhavenochoice]

\> `optional` **onlyHaveNoChoice?**: `boolean`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:38](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L38)

If this is true, the choice can see only if there are no other choices. For example, all choices are one-time choices and they are already selected.

***

### props [#props]

\> **props**: `StorageObjectType`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:30](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L30)

The properties to be passed to the label.

***

### text [#text]

\> **text**: [`PixiVNJsonDialogText`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogText)

Defined in: [src/schema/PixiVNJsonLabelStep.ts:18](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L18)

The text to be displayed.

***

### type [#type]

\> **type**: `LabelRunModeType`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:26](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L26)

Label opening mode


# Type Alias: PixiVNJsonChoiceGet (/pixi-vn-json/index/type-aliases/PixiVNJsonChoiceGet)



\> **PixiVNJsonChoiceGet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:51](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L51)

Retrieves the number of times a specific choice has been selected.

## Properties [#properties]

### index [#index]

\> **index**: `number`

Defined in: [src/schema/PixiVNJsonValue.ts:57](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L57)

index of the choice

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"get"`

Defined in: [src/schema/PixiVNJsonValue.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L53)

***

### storageType [#storagetype]

\> **storageType**: `"choice"`

Defined in: [src/schema/PixiVNJsonValue.ts:61](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L61)

If it is a choice, the value will be get with the function narration.queries.timesChoiceMade

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:52](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L52)


# Type Alias: PixiVNJsonChoices (/pixi-vn-json/index/type-aliases/PixiVNJsonChoices)



\> **PixiVNJsonChoices** = ([`PixiVNJsonChoice`](/pixi-vn-json/index/type-aliases/PixiVNJsonChoice) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<[`PixiVNJsonChoice`](/pixi-vn-json/index/type-aliases/PixiVNJsonChoice)>)\[]

Defined in: [src/schema/PixiVNJsonLabelStep.ts:47](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L47)

A list of choices (possibly conditional) that are shown to the player as a menu.


# Type Alias: PixiVNJsonComparation (/pixi-vn-json/index/type-aliases/PixiVNJsonComparation)



\> **PixiVNJsonComparation** = `object`

Defined in: [src/schema/PixiVNJsonConditions.ts:22](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L22)

Comparation for PixiVNJson.
In this comparation, the values to be converted to string and compared.

## Properties [#properties]

### leftValue [#leftvalue]

\> **leftValue**: `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditions`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)

Defined in: [src/schema/PixiVNJsonConditions.ts:27](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L27)

Left value of the comparation

***

### operator [#operator]

\> **operator**: [`PixiVNJsonComparationOperatorsType`](/pixi-vn-json/index/type-aliases/PixiVNJsonComparationOperatorsType)

Defined in: [src/schema/PixiVNJsonConditions.ts:35](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L35)

Operator of the comparation

***

### rightValue [#rightvalue]

\> **rightValue**: `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditions`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)

Defined in: [src/schema/PixiVNJsonConditions.ts:31](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L31)

Right value of the comparation

***

### type [#type]

\> **type**: `"compare"`

Defined in: [src/schema/PixiVNJsonConditions.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L23)


# Type Alias: PixiVNJsonComparationOperatorsType (/pixi-vn-json/index/type-aliases/PixiVNJsonComparationOperatorsType)



\> **PixiVNJsonComparationOperatorsType** = `"=="` | `"!="` | `"<"` | `"<="` | `">"` | `">="` | `"CONTAINS"`

Defined in: [src/schema/PixiVNJsonConditions.ts:16](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L16)

Supported comparison operators.

* `"=="` equal
* `"!="` not equal
* `"<"` less than
* `"<="` less than or equal
* `">"` greater than
* `">="` greater than or equal
* `"CONTAINS"` checks whether the left string/array contains the right value, if left and right are arrays, checks if all items in right are included in left


# Type Alias: PixiVNJsonConditionalOperation (/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalOperation)



\> **PixiVNJsonConditionalOperation** = [`PixiVNJsonOperation`](/pixi-vn-json/index/type-aliases/PixiVNJsonOperation) | [`PixiVNJsonIfElse`](/pixi-vn-json/index/interfaces/PixiVNJsonIfElse)\<[`PixiVNJsonOperation`](/pixi-vn-json/index/type-aliases/PixiVNJsonOperation)> | [`PixiVNJsonOperationString`](/pixi-vn-json/index/type-aliases/PixiVNJsonOperationString)

Defined in: [src/schema/PixiVNJsonOperations.ts:49](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonOperations.ts#L49)

A conditional operation — either a plain operation, an if-else that resolves to one,
or an operation-string (string interpolation expression).


# Type Alias: PixiVNJsonConditionalResultToCombine<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalResultToCombine)



\> **PixiVNJsonConditionalResultToCombine**\<`T`> = `object`

Defined in: [src/schema/PixiVNJsonConditionalResultToCombine.ts:8](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalResultToCombine.ts#L8)

This element is used in case a [PixiVNJsonConditionalStatements](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements) gives a result that must be combined with another calculated through other [PixiVNJsonConditionalStatements](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements).
in case this possibility is not managed, it will be taken into consideration [PixiVNJsonConditionalResultToCombine.firstItem](#firstitem)

## Type Parameters [#type-parameters]

### T [#t]

`T`

## Properties [#properties]

### combine [#combine]

\> **combine**: `"cross"` | `"union"`

Defined in: [src/schema/PixiVNJsonConditionalResultToCombine.ts:15](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalResultToCombine.ts#L15)

Defines how the two results are combined:

* `"cross"` — cartesian product / pairwise combination of both results
* `"union"` — concatenation / merge of both results into a single collection

***

### firstItem? [#firstitem]

\> `optional` **firstItem?**: `T`

Defined in: [src/schema/PixiVNJsonConditionalResultToCombine.ts:19](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalResultToCombine.ts#L19)

The first (primary) result item, used as a fallback if the second conditional produces no result.

***

### secondConditionalItem? [#secondconditionalitem]

\> `optional` **secondConditionalItem?**: [`PixiVNJsonStepSwitchElementType`](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementType)\<`T`>\[]

Defined in: [src/schema/PixiVNJsonConditionalResultToCombine.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalResultToCombine.ts#L23)

The second conditional item(s) whose result will be combined with [firstItem](#firstitem).

***

### type [#type]

\> **type**: `"resulttocombine"`

Defined in: [src/schema/PixiVNJsonConditionalResultToCombine.ts:9](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalResultToCombine.ts#L9)


# Type Alias: PixiVNJsonConditionalStatements<Then> (/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)



\> **PixiVNJsonConditionalStatements**\<`Then`> = [`PixiVNJsonStepSwitch`](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitch)\<`Then`> | [`PixiVNJsonIfElse`](/pixi-vn-json/index/interfaces/PixiVNJsonIfElse)\<`Then` | `PixiVNJsonConditionalStatements`\<`Then`> | [`PixiVNJsonConditionalResultToCombine`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalResultToCombine)\<`Then`>>

Defined in: [src/schema/PixiVNJsonConditionalStatements.ts:12](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditionalStatements.ts#L12)

A conditional statement that evaluates to a value of type `Then`.
It can be either:

* a [PixiVNJsonStepSwitch](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitch) — selects a result from a list based on a strategy (random, sequential, loop)
* a [PixiVNJsonIfElse](/pixi-vn-json/index/interfaces/PixiVNJsonIfElse) — evaluates a condition and returns the matching branch result,
  which may itself be another conditional or a [PixiVNJsonConditionalResultToCombine](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalResultToCombine)

## Type Parameters [#type-parameters]

### Then [#then]

`Then`


# Type Alias: PixiVNJsonConditions (/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)



\> **PixiVNJsonConditions** = [`PixiVNJsonComparation`](/pixi-vn-json/index/type-aliases/PixiVNJsonComparation) | `PixiVNJsonValueCondition` | [`PixiVNJsonUnionCondition`](/pixi-vn-json/index/type-aliases/PixiVNJsonUnionCondition) | [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations)

Defined in: [src/schema/PixiVNJsonConditions.ts:50](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonConditions.ts#L50)

Union of all condition types supported by PixiVNJson:

* [PixiVNJsonComparation](/pixi-vn-json/index/type-aliases/PixiVNJsonComparation) — binary comparison between two values
* PixiVNJsonValueCondition — truthy/falsy check on a plain value
* [PixiVNJsonUnionCondition](/pixi-vn-json/index/type-aliases/PixiVNJsonUnionCondition) — logical AND, OR, or NOT of other conditions
* [PixiVNJsonArithmeticOperations](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) — arithmetic result used as a boolean (non-zero = true)


# Type Alias: PixiVNJsonDialog<Text> (/pixi-vn-json/index/type-aliases/PixiVNJsonDialog)



\> **PixiVNJsonDialog**\<`Text`> = \{ `character`: `string`; `text`: `Text`; } | `Text`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:71](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L71)

A dialogue line, optionally attributed to a character.
When a plain `Text` value is used, no character attribution is included.

## Type Parameters [#type-parameters]

### Text [#text]

`Text` = `string`

## Union Members [#union-members]

### Type Literal [#type-literal]

\{ `character`: `string`; `text`: `Text`; }

#### character [#character]

\> **character**: `string`

The character id that will speak.

#### text [#text-1]

\> **text**: `Text`

The text to be displayed.

***

`Text`


# Type Alias: PixiVNJsonDialogText (/pixi-vn-json/index/type-aliases/PixiVNJsonDialogText)



\> **PixiVNJsonDialogText** = `string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | `string`\[]> | (`string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | `string`\[]>)\[]

Defined in: [src/schema/PixiVNJsonLabelStep.ts:57](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L57)

The text content of a dialogue line.
Can be a plain string, a dynamic value-get, a conditional expression, or an array of any of these
(which will be concatenated into a single string at runtime).


# Type Alias: PixiVNJsonDialogue (/pixi-vn-json/index/type-aliases/PixiVNJsonDialogue)



\> **PixiVNJsonDialogue** = `object`

Defined in: [src/schema/PixiVNJsonNarration.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L23)

Clears (resets) the current dialogue state.
This is typically used to wipe any displayed text before showing new content.

## Properties [#properties]

### operationType [#operationtype]

\> **operationType**: `"clean"`

Defined in: [src/schema/PixiVNJsonNarration.ts:25](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L25)

***

### type [#type]

\> **type**: `"dialogue"`

Defined in: [src/schema/PixiVNJsonNarration.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L24)


# Type Alias: PixiVNJsonFunction (/pixi-vn-json/index/type-aliases/PixiVNJsonFunction)



\> **PixiVNJsonFunction** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:89](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L89)

Invokes a named function and returns its result.
Functions are registered in the Pixi'VN runtime and can receive typed arguments.

## Properties [#properties]

### args [#args]

\> **args**: ([`PixiVNJsonConditions`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions) | `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations))\[]

Defined in: [src/schema/PixiVNJsonValue.ts:99](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L99)

Arguments to pass to the function. Each argument can be a condition, a raw value,
a value-get operation, or an arithmetic expression.

***

### functionName [#functionname]

\> **functionName**: `string`

Defined in: [src/schema/PixiVNJsonValue.ts:94](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L94)

The name of the registered function to call.

***

### type [#type]

\> **type**: `"function"`

Defined in: [src/schema/PixiVNJsonValue.ts:90](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L90)


# Type Alias: PixiVNJsonImageContainerEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonImageContainerEdit)



\> **PixiVNJsonImageContainerEdit** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:133](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L133)

Edits the properties of an existing image container on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:139](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L139)

Alias of the canvas element to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:135](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L135)

***

### props? [#props]

\> `optional` **props?**: `Partial`\<`ImageContainerMemory`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:143](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L143)

Partial memory/state properties to update on the image container.

***

### type [#type]

\> **type**: `"imagecontainer"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:134](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L134)


# Type Alias: PixiVNJsonImageEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonImageEdit)



\> **PixiVNJsonImageEdit** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:103](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L103)

Edits the properties of an existing image sprite on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:109](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L109)

Alias of the canvas element to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:105](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L105)

***

### props? [#props]

\> `optional` **props?**: `Partial`\<`ImageSpriteMemory`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:113](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L113)

Partial memory/state properties to update on the image sprite.

***

### type [#type]

\> **type**: `"image"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:104](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L104)


# Type Alias: PixiVNJsonInputRequest (/pixi-vn-json/index/type-aliases/PixiVNJsonInputRequest)



\> **PixiVNJsonInputRequest** = `object`

Defined in: [src/schema/PixiVNJsonNarration.ts:5](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L5)

Requests user input during the narrative.
When this operation is encountered, the engine pauses and waits for the player to provide a value.

## Properties [#properties]

### defaultValue? [#defaultvalue]

\> `optional` **defaultValue?**: `any`

Defined in: [src/schema/PixiVNJsonNarration.ts:16](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L16)

A default value that will be used if the player does not provide any input.

***

### operationType [#operationtype]

\> **operationType**: `"request"`

Defined in: [src/schema/PixiVNJsonNarration.ts:7](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L7)

***

### type [#type]

\> **type**: `"input"`

Defined in: [src/schema/PixiVNJsonNarration.ts:6](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L6)

***

### valueType? [#valuetype]

\> `optional` **valueType?**: `string`

Defined in: [src/schema/PixiVNJsonNarration.ts:12](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L12)

The expected value type for the input (e.g. `"string"`, `"number"`, `"boolean"`).
Used by the engine to validate or cast the player's answer.


# Type Alias: PixiVNJsonLabelGet (/pixi-vn-json/index/type-aliases/PixiVNJsonLabelGet)



\> **PixiVNJsonLabelGet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:36](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L36)

Retrieves the number of times a label has been opened.

## Properties [#properties]

### label [#label]

\> **label**: `string`

Defined in: [src/schema/PixiVNJsonValue.ts:42](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L42)

Id of the label

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"get"`

Defined in: [src/schema/PixiVNJsonValue.ts:38](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L38)

***

### storageType [#storagetype]

\> **storageType**: `"label"`

Defined in: [src/schema/PixiVNJsonValue.ts:46](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L46)

If it is a label, the value will be get with the function narration.queries.timesLabelOpened

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:37](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L37)


# Type Alias: PixiVNJsonLabelStep (/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)



\> **PixiVNJsonLabelStep** = `object`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:116](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L116)

Steps of a label.
Order of operations:

1. run all [PixiVNJsonLabelStep.operations](#operations)
2. set [PixiVNJsonLabelStep.choices](#choices), [PixiVNJsonLabelStep.dialogue](#dialogue), [PixiVNJsonLabelStep.glueEnabled](#glueenabled)
3. open [PixiVNJsonLabelStep.labelToOpen](#labeltoopen)
4. go to next step if [PixiVNJsonLabelStep.goNextStep](#gonextstep) is true
5. end the label if [PixiVNJsonLabelStep.end](#end) is "label_end"

## Properties [#properties]

### choices? [#choices]

\> `optional` **choices?**: [`PixiVNJsonChoices`](/pixi-vn-json/index/type-aliases/PixiVNJsonChoices) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<[`PixiVNJsonChoices`](/pixi-vn-json/index/type-aliases/PixiVNJsonChoices)>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:124](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L124)

Variable used to display a choice menu.

***

### conditionalStep? [#conditionalstep]

\> `optional` **conditionalStep?**: [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`PixiVNJsonLabelStep` | `PixiVNJsonLabelStep`\[]>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:157](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L157)

If set, this step is replaced by the result of evaluating the given conditional statement.
Allows an entire step to be chosen at runtime based on a condition or step-switch strategy.

***

### dialogue? [#dialogue]

\> `optional` **dialogue?**: [`PixiVNJsonDialog`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialog)\<[`PixiVNJsonDialogText`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogText)> | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<[`PixiVNJsonDialog`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialog)\<[`PixiVNJsonDialogText`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogText)>>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:128](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L128)

Variable used to display a dialog.

***

### end? [#end]

\> `optional` **end?**: `"game_end"` | `"label_end"` | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`"game_end"` | `"label_end"`>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:152](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L152)

Variable used to end some elements of the narrative.

* game_end: ends the game
* label_end: ends the label

***

### glueEnabled? [#glueenabled]

\> `optional` **glueEnabled?**: `boolean` | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`boolean`>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:135](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L135)

This variable is used to add the next dialog text into the current dialog memory.
This value was added to introduce Ink Glue functionality [https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue)

***

### goNextStep? [#gonextstep]

\> `optional` **goNextStep?**: `boolean` | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`boolean`>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:146](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L146)

If is true, the next step will be executed automatically.

***

### labelToOpen? [#labeltoopen]

\> `optional` **labelToOpen?**: [`PixiVNJsonLabelToOpen`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<[`PixiVNJsonLabelToOpen`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen)> | ([`PixiVNJsonLabelToOpen`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<[`PixiVNJsonLabelToOpen`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen)>)\[]

Defined in: [src/schema/PixiVNJsonLabelStep.ts:139](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L139)

Variable used to open a label.

***

### operations? [#operations]

\> `optional` **operations?**: [`PixiVNJsonConditionalOperation`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalOperation)\[]

Defined in: [src/schema/PixiVNJsonLabelStep.ts:120](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L120)

Operations to execute at the start of this step (storage writes, canvas updates, sound, etc.).


# Type Alias: PixiVNJsonLabelToOpen<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonLabelToOpen)



\> **PixiVNJsonLabelToOpen**\<`T`> = `object`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:87](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L87)

Describes a label that should be opened (called or jumped to) during a step.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `object` = `object`

## Properties [#properties]

### label [#label]

\> **label**: `string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet)

Defined in: [src/schema/PixiVNJsonLabelStep.ts:91](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L91)

The id of the label to open.

***

### params? [#params]

\> `optional` **params?**: `unknown`\[]

Defined in: [src/schema/PixiVNJsonLabelStep.ts:104](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L104)

**It is not recommended to use it, use it only if necessary**. The parameters to be passed to the label. If you want to pass an object, use the [PixiVNJsonLabelToOpen.props](#props) attribute.
"params" attribute will be stored in the temp storage with the key: [PIXIVNJSON_PARAM_ID](/pixi-vn-json/index/variables/PIXIVNJSON_PARAM_ID) + (narration.labels.opened.length - 1).

***

### props? [#props]

\> `optional` **props?**: `StepLabelPropsType`\<`T`>

Defined in: [src/schema/PixiVNJsonLabelStep.ts:99](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L99)

The properties to be passed to the label. if you don't want to pass a object, but a list of parameters, you can use the [PixiVNJsonLabelToOpen.params](#params) attribute.

***

### type [#type]

\> **type**: `LabelRunModeType`

Defined in: [src/schema/PixiVNJsonLabelStep.ts:95](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabelStep.ts#L95)

Label opening mode


# Type Alias: PixiVNJsonLabels (/pixi-vn-json/index/type-aliases/PixiVNJsonLabels)



\> **PixiVNJsonLabels** = `object`

Defined in: [src/schema/PixiVNJsonLabels.ts:6](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonLabels.ts#L6)

Collection of labels to be used in the narrative.

## Index Signature [#index-signature]

\[`labelId`: `string`]: [`PixiVNJsonLabelStep`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelStep)\[]


# Type Alias: PixiVNJsonLogicGet (/pixi-vn-json/index/type-aliases/PixiVNJsonLogicGet)



\> **PixiVNJsonLogicGet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:66](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L66)

Retrieves a value from the logic/arithmetic layer (result of a computation or condition).

## Properties [#properties]

### operation [#operation]

\> **operation**: [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) | [`PixiVNJsonConditions`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions)

Defined in: [src/schema/PixiVNJsonValue.ts:72](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L72)

The arithmetic or conditional operation whose result is the retrieved value.

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"get"`

Defined in: [src/schema/PixiVNJsonValue.ts:68](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L68)

***

### storageType [#storagetype]

\> **storageType**: `"logic"`

Defined in: [src/schema/PixiVNJsonValue.ts:73](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L73)

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:67](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L67)


# Type Alias: PixiVNJsonMediaTransiotions (/pixi-vn-json/index/type-aliases/PixiVNJsonMediaTransiotions)



\> **PixiVNJsonMediaTransiotions** = [`DissolveTransition`](/pixi-vn-json/index/type-aliases/DissolveTransition) | [`FadeTransition`](/pixi-vn-json/index/type-aliases/FadeTransition) | [`MoveInOutTransition`](/pixi-vn-json/index/type-aliases/MoveInOutTransition) | [`ZoomInOutTransition`](/pixi-vn-json/index/type-aliases/ZoomInOutTransition) | [`PushInOutTransition`](/pixi-vn-json/index/type-aliases/PushInOutTransition)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:108](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L108)

Union of all supported canvas media transitions.


# Type Alias: PixiVNJsonNarration (/pixi-vn-json/index/type-aliases/PixiVNJsonNarration)



\> **PixiVNJsonNarration** = [`PixiVNJsonDialogue`](/pixi-vn-json/index/type-aliases/PixiVNJsonDialogue) | [`PixiVNJsonInputRequest`](/pixi-vn-json/index/type-aliases/PixiVNJsonInputRequest)

Defined in: [src/schema/PixiVNJsonNarration.ts:31](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonNarration.ts#L31)

Narration operation — either a dialogue clear or a user-input request.


# Type Alias: PixiVNJsonOnlyStorageSet (/pixi-vn-json/index/type-aliases/PixiVNJsonOnlyStorageSet)



\> **PixiVNJsonOnlyStorageSet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:110](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L110)

Sets a value in either the persistent storage or the temporary (session) storage.

## Properties [#properties]

### key [#key]

\> **key**: `string`

Defined in: [src/schema/PixiVNJsonValue.ts:116](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L116)

Key of the storage

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"set"`

Defined in: [src/schema/PixiVNJsonValue.ts:112](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L112)

***

### storageType [#storagetype]

\> **storageType**: `"storage"` | `"tempstorage"`

Defined in: [src/schema/PixiVNJsonValue.ts:128](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L128)

Type of the storage, if it is a flagStorage or a storage.

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:111](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L111)

***

### value [#value]

\> **value**: `StorageElementType` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonArithmeticOperations`](/pixi-vn-json/index/type-aliases/PixiVNJsonArithmeticOperations) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`StorageElementType`>

Defined in: [src/schema/PixiVNJsonValue.ts:120](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L120)

Value to be set in the storage


# Type Alias: PixiVNJsonOperation (/pixi-vn-json/index/type-aliases/PixiVNJsonOperation)



\> **PixiVNJsonOperation** = [`PixiVNJsonValueSet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueSet) | [`PixiVNJsonCanvas`](/pixi-vn-json/index/type-aliases/PixiVNJsonCanvas) | [`PixiVNJsonSound`](/pixi-vn-json/index/type-aliases/PixiVNJsonSound) | [`PixiVNJsonNarration`](/pixi-vn-json/index/type-aliases/PixiVNJsonNarration) | [`PixiVNJsonFunction`](/pixi-vn-json/index/type-aliases/PixiVNJsonFunction) & `object`

Defined in: [src/schema/PixiVNJsonOperations.ts:32](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonOperations.ts#L32)

A single resolved operation — a value set, canvas operation, sound operation,
narration operation, or function call — optionally annotated with an origin string.

## Type Declaration [#type-declaration]

### $origin? [#origin]

\> `optional` **$origin?**: `string`

This value is used by the system to know where this operation is from, for example, if is generated from a string operation.


# Type Alias: PixiVNJsonOperationString (/pixi-vn-json/index/type-aliases/PixiVNJsonOperationString)



\> **PixiVNJsonOperationString** = `object`

Defined in: [src/schema/PixiVNJsonOperations.ts:16](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonOperations.ts#L16)

An operation string that holds a list of string/value fragments to be concatenated at runtime.
Used internally to represent string interpolation expressions before they are fully resolved.

## Properties [#properties]

### type [#type]

\> **type**: `"operationtoconvert"`

Defined in: [src/schema/PixiVNJsonOperations.ts:17](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonOperations.ts#L17)

***

### values [#values]

\> **values**: (`string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet) | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`string` | [`PixiVNJsonValueGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet)>)\[]

Defined in: [src/schema/PixiVNJsonOperations.ts:21](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonOperations.ts#L21)

The ordered list of string fragments and/or value-get expressions to concatenate.


# Type Alias: PixiVNJsonParamGet (/pixi-vn-json/index/type-aliases/PixiVNJsonParamGet)



\> **PixiVNJsonParamGet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:23](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L23)

## Properties [#properties]

### key [#key]

\> **key**: `number`

Defined in: [src/schema/PixiVNJsonValue.ts:29](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L29)

Index of the parameter in the params array.

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"get"`

Defined in: [src/schema/PixiVNJsonValue.ts:25](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L25)

***

### storageType [#storagetype]

\> **storageType**: `"params"`

Defined in: [src/schema/PixiVNJsonValue.ts:30](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L30)

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L24)


# Type Alias: PixiVNJsonSound (/pixi-vn-json/index/type-aliases/PixiVNJsonSound)



\> **PixiVNJsonSound** = [`PixiVNJsonSoundPlay`](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPlay) | [`PixiVNJsonSoundRemove`](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundRemove) | [`PixiVNJsonSoundPauseResume`](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPauseResume) | [`PixiVNJsonSoundEdit`](/pixi-vn-json/index/type-aliases/PixiVNJsonSoundEdit)

Defined in: [src/schema/PixiVNJsonSound.ts:78](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L78)

Union of all sound operations — play, stop, pause/resume, and edit.


# Type Alias: PixiVNJsonSoundEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonSoundEdit)



\> **PixiVNJsonSoundEdit** = `object`

Defined in: [src/schema/PixiVNJsonSound.ts:62](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L62)

Edits the properties of a currently playing sound (volume, speed, muted, loop, etc.).

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonSound.ts:68](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L68)

Alias of the sound to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonSound.ts:64](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L64)

***

### props [#props]

\> **props**: [`PixiVNJsonSoundEditProps`](/pixi-vn-json/index/interfaces/PixiVNJsonSoundEditProps)

Defined in: [src/schema/PixiVNJsonSound.ts:72](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L72)

Partial set of properties to apply to the sound.

***

### type [#type]

\> **type**: `"sound"`

Defined in: [src/schema/PixiVNJsonSound.ts:63](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L63)


# Type Alias: PixiVNJsonSoundPauseResume (/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPauseResume)



\> **PixiVNJsonSoundPauseResume** = \{ `alias`: `string`; `operationType`: `"pause"` | `"resume"`; `type`: `"sound"` | `"channel"`; } | \{ `operationType`: `"pause"` | `"resume"` | `"stop"`; `type`: `"all"`; }

Defined in: [src/schema/PixiVNJsonSound.ts:40](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L40)

Pauses or resumes a sound, a channel, or all audio.

## Union Members [#union-members]

### Type Literal [#type-literal]

\{ `alias`: `string`; `operationType`: `"pause"` | `"resume"`; `type`: `"sound"` | `"channel"`; }

#### alias [#alias]

\> **alias**: `string`

Alias of the sound or channel to pause/resume.

#### operationType [#operationtype]

\> **operationType**: `"pause"` | `"resume"`

#### type [#type]

\> **type**: `"sound"` | `"channel"`

***

### Type Literal [#type-literal-1]

\{ `operationType`: `"pause"` | `"resume"` | `"stop"`; `type`: `"all"`; }


# Type Alias: PixiVNJsonSoundPlay (/pixi-vn-json/index/type-aliases/PixiVNJsonSoundPlay)



\> **PixiVNJsonSoundPlay** = `object`

Defined in: [src/schema/PixiVNJsonSound.ts:10](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L10)

Starts playback of a sound asset.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonSound.ts:16](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L16)

Unique identifier (alias) used to reference this sound.

***

### operationType [#operationtype]

\> **operationType**: `"play"`

Defined in: [src/schema/PixiVNJsonSound.ts:12](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L12)

***

### props? [#props]

\> `optional` **props?**: [`PixiVNJsonSoundPlayProps`](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps)

Defined in: [src/schema/PixiVNJsonSound.ts:24](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L24)

Playback options such as volume, loop, channel, and start offset.

***

### type [#type]

\> **type**: `"sound"`

Defined in: [src/schema/PixiVNJsonSound.ts:11](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L11)

***

### url? [#url]

\> `optional` **url?**: `string`

Defined in: [src/schema/PixiVNJsonSound.ts:20](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L20)

URL of the sound file. If omitted, the alias is used as the URL.


# Type Alias: PixiVNJsonSoundRemove (/pixi-vn-json/index/type-aliases/PixiVNJsonSoundRemove)



\> **PixiVNJsonSoundRemove** = `object`

Defined in: [src/schema/PixiVNJsonSound.ts:29](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L29)

Stops a playing sound and removes it from the audio context.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonSound.ts:35](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L35)

Alias of the sound to stop.

***

### operationType [#operationtype]

\> **operationType**: `"stop"`

Defined in: [src/schema/PixiVNJsonSound.ts:31](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L31)

***

### type [#type]

\> **type**: `"sound"`

Defined in: [src/schema/PixiVNJsonSound.ts:30](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonSound.ts#L30)


# Type Alias: PixiVNJsonStepSwitch<Then> (/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitch)



\> **PixiVNJsonStepSwitch**\<`Then`> = `PixiVNJsonRandom`\<`Then`> | `PixiVNJsonSequential`\<`Then`> | `PixiVNJsonLoop`\<`Then`> | `PixiVNJsonSequentialRandom`\<`Then`>

Defined in: [src/schema/PixiVNJsonStepSwitch.ts:89](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonStepSwitch.ts#L89)

A step-switch selects one element from a list using a defined strategy (random, sequential, loop, or sequential-random).

## Type Parameters [#type-parameters]

### Then [#then]

`Then`


# Type Alias: PixiVNJsonStepSwitchElementType<Then> (/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementType)



\> **PixiVNJsonStepSwitchElementType**\<`Then`> = `Then` | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`Then`> | [`PixiVNJsonConditionalResultToCombine`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalResultToCombine)\<`Then`>

Defined in: [src/schema/PixiVNJsonStepSwitch.ts:8](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonStepSwitch.ts#L8)

A single element that can appear inside a step-switch, which may be a direct value,
a conditional statement, or a result-to-combine.

## Type Parameters [#type-parameters]

### Then [#then]

`Then`


# Type Alias: PixiVNJsonStepSwitchElementsType<Then> (/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementsType)



\> **PixiVNJsonStepSwitchElementsType**\<`Then`> = [`PixiVNJsonStepSwitchElementType`](/pixi-vn-json/index/type-aliases/PixiVNJsonStepSwitchElementType)\<`Then`>\[] | [`PixiVNJsonConditionalStatements`](/pixi-vn-json/index/type-aliases/PixiVNJsonConditionalStatements)\<`Then`\[]>

Defined in: [src/schema/PixiVNJsonStepSwitch.ts:15](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonStepSwitch.ts#L15)

The elements collection of a step-switch — either a plain array or a conditional that produces an array.

## Type Parameters [#type-parameters]

### Then [#then]

`Then`


# Type Alias: PixiVNJsonStorageGet (/pixi-vn-json/index/type-aliases/PixiVNJsonStorageGet)



\> **PixiVNJsonStorageGet** = `object`

Defined in: [src/schema/PixiVNJsonValue.ts:9](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L9)

Retrieves a value from the persistent storage, flag storage, or temporary storage.

## Properties [#properties]

### key [#key]

\> **key**: `string`

Defined in: [src/schema/PixiVNJsonValue.ts:15](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L15)

Key of the storage

***

### storageOperationType [#storageoperationtype]

\> **storageOperationType**: `"get"`

Defined in: [src/schema/PixiVNJsonValue.ts:11](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L11)

***

### storageType [#storagetype]

\> **storageType**: `"storage"` | `"flagStorage"` | `"tempstorage"`

Defined in: [src/schema/PixiVNJsonValue.ts:20](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L20)

Type of the storage, if it is a flagStorage or a storage.
If it is a flagStorage, the value will be get with the function storage.flags.get

***

### type [#type]

\> **type**: `"value"`

Defined in: [src/schema/PixiVNJsonValue.ts:10](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L10)


# Type Alias: PixiVNJsonTextEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonTextEdit)



\> **PixiVNJsonTextEdit** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:148](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L148)

Edits the properties of an existing text element on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:154](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L154)

Alias of the canvas element to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:150](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L150)

***

### props? [#props]

\> `optional` **props?**: `Partial`\<`TextMemory`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:158](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L158)

Partial memory/state properties to update on the text element.

***

### type [#type]

\> **type**: `"text"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:149](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L149)


# Type Alias: PixiVNJsonUnionCondition (/pixi-vn-json/index/type-aliases/PixiVNJsonUnionCondition)



\> **PixiVNJsonUnionCondition** = `PixiVNJsonUnionConditionAndOr` | `PixiVNJsonUnionConditionNot`

Defined in: [src/schema/PixiVNJsonUnionCondition.ts:32](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonUnionCondition.ts#L32)

Union of AND/OR and NOT logical operators over conditions.


# Type Alias: PixiVNJsonUnknownEdit<T> (/pixi-vn-json/index/type-aliases/PixiVNJsonUnknownEdit)



\> **PixiVNJsonUnknownEdit**\<`T`> = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:164](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L164)

Edits the properties of an unknown/generic canvas element.
Use this when the specific element type is not one of the built-in kinds.

## Type Parameters [#type-parameters]

### T [#t]

`T` *extends* `ContainerOptions`\<`any`>

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:170](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L170)

Alias of the canvas element to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:166](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L166)

***

### props? [#props]

\> `optional` **props?**: `Partial`\<`T`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:174](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L174)

Partial options/properties to update on the canvas element.

***

### type [#type]

\> **type**: `"canvaselement"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:165](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L165)


# Type Alias: PixiVNJsonValueGet (/pixi-vn-json/index/type-aliases/PixiVNJsonValueGet)



\> **PixiVNJsonValueGet** = [`PixiVNJsonStorageGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonStorageGet) | [`PixiVNJsonParamGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonParamGet) | [`PixiVNJsonLabelGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonLabelGet) | [`PixiVNJsonChoiceGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonChoiceGet) | [`PixiVNJsonLogicGet`](/pixi-vn-json/index/type-aliases/PixiVNJsonLogicGet) | [`PixiVNJsonFunction`](/pixi-vn-json/index/type-aliases/PixiVNJsonFunction)

Defined in: [src/schema/PixiVNJsonValue.ts:78](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L78)

Union of all "get value" operations — reads from storage, params, labels, choices, or a logic expression.


# Type Alias: PixiVNJsonValueSet (/pixi-vn-json/index/type-aliases/PixiVNJsonValueSet)



\> **PixiVNJsonValueSet** = [`PixiVNJsonOnlyStorageSet`](/pixi-vn-json/index/type-aliases/PixiVNJsonOnlyStorageSet) | `PixiVNJsonFlagSet` | `PixiVNJsonOnlyParamSet`

Defined in: [src/schema/PixiVNJsonValue.ts:176](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonValue.ts#L176)

Union of all "set value" operations — writes to storage, flag storage, or params.


# Type Alias: PixiVNJsonVideoEdit (/pixi-vn-json/index/type-aliases/PixiVNJsonVideoEdit)



\> **PixiVNJsonVideoEdit** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:118](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L118)

Edits the properties of an existing video sprite on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:124](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L124)

Alias of the canvas element to edit.

***

### operationType [#operationtype]

\> **operationType**: `"edit"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:120](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L120)

***

### props? [#props]

\> `optional` **props?**: `Partial`\<`VideoSpriteMemory`>

Defined in: [src/schema/PixiVNJsonCanvas.ts:128](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L128)

Partial memory/state properties to update on the video sprite.

***

### type [#type]

\> **type**: `"video"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:119](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L119)


# Type Alias: PixiVNJsonVideoPauseResume (/pixi-vn-json/index/type-aliases/PixiVNJsonVideoPauseResume)



\> **PixiVNJsonVideoPauseResume** = `object`

Defined in: [src/schema/PixiVNJsonCanvas.ts:201](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L201)

Pauses or resumes playback of a video sprite on the canvas.

## Properties [#properties]

### alias [#alias]

\> **alias**: `string`

Defined in: [src/schema/PixiVNJsonCanvas.ts:207](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L207)

Alias of the video element to pause or resume.

***

### operationType [#operationtype]

\> **operationType**: `"pause"` | `"resume"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:203](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L203)

***

### type [#type]

\> **type**: `"video"`

Defined in: [src/schema/PixiVNJsonCanvas.ts:202](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonCanvas.ts#L202)


# Type Alias: PushInOutTransition (/pixi-vn-json/index/type-aliases/PushInOutTransition)



\> **PushInOutTransition** = `object`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:93](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L93)

Push-in / Push-out transition — pushes the element onto or off the viewport, displacing the current content.

## Properties [#properties]

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:102](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L102)

Pixi.js update priority for the transition ticker callback.

***

### props? [#props]

\> `optional` **props?**: [`PushInOutTransitionProps`](/pixi-vn-json/index/interfaces/PushInOutTransitionProps)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:98](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L98)

Configuration options for the push transition (direction, duration, easing, etc.).

***

### type [#type]

\> **type**: `"pushin"` | `"pushout"`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:94](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L94)


# Type Alias: ReplaceHandler (/pixi-vn-json/index/type-aliases/ReplaceHandler)



\> **ReplaceHandler** = (`key`) => `string` | `undefined`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:11](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L11)

A handler function invoked for each `[key]` token found in the text that passes the
[ReplaceHandlerOptions.validation](/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions#validation) check.

## Parameters [#parameters]

### key [#key]

`string`

The content found inside the square brackets (without the brackets themselves).
For example, for the token `[john]` the key is `"john"`.

## Returns [#returns]

`string` | `undefined`

The string to substitute in place of `[key]`, or `undefined` to leave the token unchanged.


# Type Alias: ReplaceHandlerOptions (/pixi-vn-json/index/type-aliases/ReplaceHandlerOptions)



\> **ReplaceHandlerOptions** = `object`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:21](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L21)

Configuration options for a text-replacement handler registered via [TextReplaces.add](/pixi-vn-json/index/namespaces/TextReplaces/functions/add).

## Properties [#properties]

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:31](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L31)

An optional human-readable description of what this handler does.
Used for documentation purposes.

***

### i18nInterpolation? [#i18ninterpolation]

\> `optional` **i18nInterpolation?**: `boolean`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:91](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L91)

When `true`, the **first** occurrence of a matched `[key]` token is converted to the i18n
double-brace format `{{[key]}}` (exactly once). Any subsequent occurrences of `[key]` in
the same text are then replaced with the handler's return value as usual.

The transformation sequence for a matched key is:

* first occurrence: `[key]` → `{{[key]}}`
* remaining occurrences: `[key]` → handler return value

When `false` or omitted, the handler's return value directly replaces all occurrences of `[key]`.

**Recommended i18n configuration:** when this option is enabled, configure
`missingInterpolationHandler` in your i18n instance so that keys with no matching
translation are left intact rather than replaced with an empty string:

```ts title="lib/i18n.ts"
i18n.init({
    // ...
    missingInterpolationHandler(_text, value, _options) {
        return value[1];
    },
});
```

#### Default [#default]

```ts
false
```

***

### name [#name]

\> **name**: `string`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:26](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L26)

A unique name that identifies this handler.
Used for documentation and debugging purposes.

***

### type? [#type]

\> `optional` **type?**: `"after-translation"` | `"before-translation"`

Defined in: [src/translator/interfaces/ReplaceHandler.ts:64](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L64)

When this handler should be invoked relative to the translation step.

* `"before-translation"` – the handler runs **before** onInkTranslate is called.
  Useful for pre-processing tokens, e.g. converting `[key]` into `{{key}}` for i18next.
* `"after-translation"` – the handler runs **after** onInkTranslate is called.
  Useful for substituting values that depend on the translated text.

#### Default [#default-1]

```ts
"after-translation"
```

***

### validation [#validation]

\> **validation**: `RegExp` | `"characterId"` | `"all"` | `ZodType`\<`string`>

Defined in: [src/translator/interfaces/ReplaceHandler.ts:53](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/translator/interfaces/ReplaceHandler.ts#L53)

Determines whether this handler should be invoked for a given `[key]` token.

* `"all"` – the handler is always invoked for every token found.
* `"characterId"` – the handler is invoked only when the key matches a registered character ID
  (i.e. the character is present in `RegisteredCharacters`).
* `RegExp` – the key string is tested against the regular expression. The handler is invoked
  only if the regex matches.
* `ZodType<string>` – the key string is validated with `schema.safeParse(key)`. The handler
  is invoked only if validation succeeds.

#### Example [#example]

```ts
// RegExp: only replace keys that look like lowercase identifiers
validation: /^[a-z_]+$/

// Zod: only replace keys that are one of a fixed set of values
import { z } from "zod"
validation: z.enum(["player", "npc", "enemy"])
```


# Type Alias: VariableGetterHandler (/pixi-vn-json/index/type-aliases/VariableGetterHandler)



\> **VariableGetterHandler** = \<`T`>(`value`, `next`) => `T` | `undefined`

Defined in: [src/actions/interfaces/VariableGetterHandler.ts:11](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/actions/interfaces/VariableGetterHandler.ts#L11)

A middleware handler that can intercept and transform a logic value before it is
returned by [VariableGetter.getLogichValue](/pixi-vn-json/index/namespaces/VariableGetter/functions/getLogichValue).

Handlers are called in registration order, each receiving the current value and a
`next` function to invoke the rest of the chain (including the built-in resolver).
Return `undefined` to fall through to `next`.

## Type Parameters [#type-parameters]

### T [#t]

`T` = `StorageElementType`

## Parameters [#parameters]

### value [#value]

`T`

### next [#next]

(`value`) => `T` | `undefined`

## Returns [#returns]

`T` | `undefined`


# Type Alias: ZoomInOutTransition (/pixi-vn-json/index/type-aliases/ZoomInOutTransition)



\> **ZoomInOutTransition** = `object`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:74](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L74)

Zoom-in / Zoom-out transition — scales the element into or out of view.

## Properties [#properties]

### priority? [#priority]

\> `optional` **priority?**: `UPDATE_PRIORITY`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:83](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L83)

Pixi.js update priority for the transition ticker callback.

***

### props? [#props]

\> `optional` **props?**: [`ZoomInOutTransitionProps`](/pixi-vn-json/index/interfaces/ZoomInOutTransitionProps)

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:79](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L79)

Configuration options for the zoom transition (scale, duration, easing, etc.).

***

### type [#type]

\> **type**: `"zoomin"` | `"zoomout"`

Defined in: [src/schema/PixiVNJsonMediaTransiotions.ts:75](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/schema/PixiVNJsonMediaTransiotions.ts#L75)


# Variable: PIXIVNJSON_PARAM_ID (/pixi-vn-json/index/variables/PIXIVNJSON_PARAM_ID)



\> `const` **PIXIVNJSON_PARAM_ID**: `"___param___"` = `"___param___"`

Defined in: [src/constants.ts:10](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/constants.ts#L10)

**`Internal`**

Internal storage key prefix used to pass positional parameters to a called label.
The full key is `PIXIVNJSON_PARAM_ID + <label-depth-index>`.


# Variable: PIXIVNJSON_SCHEMA_URL (/pixi-vn-json/index/variables/PIXIVNJSON_SCHEMA_URL)



\> `const` **PIXIVNJSON_SCHEMA_URL**: `string`

Defined in: [src/constants.ts:25](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/constants.ts#L25)

The URL of the JSON Schema for the current version of pixi-vn-json.

You can use this constant as the value of the `$schema` field in your PixiVNJson documents
so that editors can validate and auto-complete the document.

Example:

```json
{
  "$schema": "https://pixi-vn.com/schemas/1.13.0/schema.json"
}
```


# Variable: PixiVNJsonComparationOperators (/pixi-vn-json/index/variables/PixiVNJsonComparationOperators)



\> `const` **PixiVNJsonComparationOperators**: [`PixiVNJsonComparationOperatorsType`](/pixi-vn-json/index/type-aliases/PixiVNJsonComparationOperatorsType)\[]

Defined in: [src/constants.ts:30](https://github.com/DRincs-Productions/pixi-vn-json/blob/f2528001a05fe854a897e0c1d03c7e311fe08af2/src/constants.ts#L30)

All comparison operators supported by [PixiVNJsonConditions](/pixi-vn-json/index/type-aliases/PixiVNJsonConditions) expressions.


# @drincs/pixi-vn-json (/pixi-vn-json/modules)



## Modules [#modules]

* [core](/pixi-vn-json/core)
* [docs-entry](/pixi-vn-json/docs-entry)
* [index](/pixi-vn-json/index)


# Pixi’VN - Ink Language Integration (/pixi-vn-ink)



![pixi-vn-cover-ink](https://github.com/user-attachments/assets/25599899-36b9-4b96-b5c1-9c99e335c3f7)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-ink" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn-ink?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-ink" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/pixi-vn-ink" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/pixi-vn-ink" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/pixi-vn-ink?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-ink" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/pixi-vn-ink" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

Pixi’VN gives you the ability to write your own narrative using **_ink_**, a scripting language for writing interactive narrative.

The ***ink* + Pixi’VN integration**, exploits the [inkjs](https://github.com/inkle/inkjs) and [PixiVNJson](https://github.com/DRincs-Productions/pixi-vn-json) libraries, to parse ***ink* code** and generate a Json that can be interpreted by Pixi’VN. So Javascript/Typescript and **_ink_** share the same storage and canvas, and it is also possible to launch **_ink_** labels (or knots) from Javascript/Typescript and vice versa. This allows you to use the best of both languages. You can use **_ink_** to write the narration, while using Javascript/Typescript to create minigames or complex animations.

**What is *ink*?**

**_ink_** is a scripting language for writing interactive narrative. It is used in games like 80 Days, Heaven's Vault, and Sorcery! to create branching stories.

This language is very simple to learn. Go on [*ink* website](https://www.inklestudios.com/ink/) to learn more about it.

## Why use *ink* integration? [#why-use-ink-integration]

Programming a game narrative in **Javascript/Typescript** has the advantage of having total development freedom, but the disadvantage is that it slows down the writing of a narrative (it makes you write a lot of code).

## Installation [#installation]

To install the package, run the following command in your project:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @drincs/pixi-vn-ink
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @drincs/pixi-vn-ink
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @drincs/pixi-vn-ink
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @drincs/pixi-vn-ink
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Start using *ink* in Pixi’VN [#start-using-ink-in-pixivn]

If you have not created a project yet then it is recommended to use the [template](https://pixi-vn.com/start/getting-started.html#project-initialization) to start your project with **_ink_**.

After installing the package you need to use the `importInkText()` function to import the ***ink* script** into your project.

```ts title="main.ts"
import { narration } from "@drincs/pixi-vn";
import { importInkText } from '@drincs/pixi-vn-ink'

importInkText([inkText, ...])
narration.callLabel(`start`, {});
```

```ink title="ink/story.ink"
=== start ===
Hello, world!
-> END
```

<CodeBlockTabs defaultValue="ink.d.ts">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="ink.d.ts">
      ink.d.ts
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="ink.d.ts">
    ```ts
    declare module "*.ink" {
      const value: string;
      export default value;
    }
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Agent Skills [#agent-skills]

This package ships a set of [Agent Skills](https://www.skills.sh/) that teach AI coding assistants
(like Claude Code) the full **ink** language plus every Pixi'VN-specific integration detail (hashtag
commands, `importInkText`, storage mapping, and every deliberate difference from native ink). Unlike
`@drincs/pixi-vn`'s skill set, where each skill can be installed independently, these are meant to
travel together — install all of them at once with:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npx skills add DRincs-Productions/pixi-vn-ink --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm dlx skills add DRincs-Productions/pixi-vn-ink --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn dlx skills add DRincs-Productions/pixi-vn-ink --all
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun x skills add DRincs-Productions/pixi-vn-ink --all
    ```
  </CodeBlockTab>
</CodeBlockTabs>

This installs every skill below:

* `getting-started` — installation, the Vite plugin, dev-server debugging, translation files, and core ink syntax as used in Pixi'VN
* `characters` — dialogue attribution, name substitution, emotions
* `input` — `# request input` prompts
* `pause-continue` — `# pause` and `<># continue`
* `markup` — Markdown/HTML/CSS in dialogue text
* `canvas` — every canvas hashtag command
* `sound` — every sound hashtag command
* `assets` — `# load`/`# lazyload`
* `text-replacement` — `[key]` substitution
* `hashtag-commands` — writing a custom hashtag command instead of an ink function
* `migration` — upgrading an existing project to the current version


# Function: addBaseHashtagCommands() (/pixi-vn-ink/index/functions/addBaseHashtagCommands)



\> **addBaseHashtagCommands**(`options?`): `void`

Defined in: [src/handlers/hashtag-commands.ts:598](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L598)

Registers every built-in Hashtag-Command → operation mapper (`call`, `jump`, `pause`,
`continue`, `show`/`edit`/`remove` for images/videos/text/canvas elements, sound and channel
controls, asset/bundle loading, input requests, …).

**This replaces the old behavior of registering these mappers as a side effect of importing
`@drincs/pixi-vn-ink`.** Call this once, near the start of your app (alongside e.g.
`createNqtrHandler`), before any Ink content is parsed.

## Parameters [#parameters]

### options? [#options]

[`BaseHashtagCommandsOptions`](/pixi-vn-ink/index/interfaces/BaseHashtagCommandsOptions) = `{}`

Optional configuration for known bundle/asset-alias ids, and which built-in
command sections (see BaseHashtagCommandsSections) to register.

## Returns [#returns]

`void`

## Example [#example]

```ts
import { addBaseHashtagCommands } from '@drincs/pixi-vn-ink';

addBaseHashtagCommands();
```


# Function: convertInkText() (/pixi-vn-ink/index/functions/convertInkText)



\> **convertInkText**(`text`, `options?`): [`PixiVNJson`](/pixi-vn-ink/index/interfaces/PixiVNJson) | `undefined`

Defined in: [src/converter/converter.ts:33](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/converter/converter.ts#L33)

This function converts string written in ink language into the LabelJsonType.

## Parameters [#parameters]

### text [#text]

`string`

string or array of strings written in ink language

### options? [#options]

`Partial`\<`LoaderSharedType`> = `{}`

## Returns [#returns]

[`PixiVNJson`](/pixi-vn-ink/index/interfaces/PixiVNJson) | `undefined`

LabelJsonType or undefined


# Function: generateJsonInkTranslation() (/pixi-vn-ink/index/functions/generateJsonInkTranslation)



\> **generateJsonInkTranslation**(`pixivnJson`, `json?`, `options?`): `Promise`\<`object`>

Defined in: [src/functions/translate.ts:38](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/functions/translate.ts#L38)

Generate a json object with the keys of the labels and the values of the text to be translated

## Parameters [#parameters]

### pixivnJson [#pixivnjson]

[`PixiVNJson`](/pixi-vn-ink/index/interfaces/PixiVNJson)

The labels to be used in the narrative. They will be added to the system

### json? [#json]

`object` = `{}`

If you want to add more keys to the existing json

### options? [#options]

The options to set the default value if the key is not found

#### defaultValue? [#defaultvalue]

`"empty_string"` | `"copy_key"`

Default value to set if the key is not found

**Default**

```ts
"copy_key"
```

## Returns [#returns]

`Promise`\<`object`>

The json object with the keys of the labels and the values of the text to be translated

## Example [#example]

```ts
import { generateTranslateJson, importInkText } from 'pixi-vn-ink'

importInkText( your_ink_text_here ).then((labels) => {
    let json = generateTranslateJson(labels)
})
```


# Function: importInkText() (/pixi-vn-ink/index/functions/importInkText)



\> **importInkText**(`texts`, `options?`): `Promise`\<`string`\[]>

Defined in: [src/loader/importer.ts:24](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/loader/importer.ts#L24)

This function imports string or array of strings written in ink language into the Pixi’VN engine.

## Parameters [#parameters]

### texts [#texts]

`string` | `string`\[]

string or array of strings written in ink language

### options? [#options]

#### characters? [#characters]

readonly [`CharacterIdSource`](/pixi-vn-ink/index/type-aliases/CharacterIdSource)\[]

characters recognised when splitting `characterId: text` speakers, in
addition to `RegisteredCharacters` (pass when importing before characters are registered)

## Returns [#returns]

`Promise`\<`string`\[]>

## Example [#example]

```ts title="main.ts"
import { importInkText } from 'pixi-vn'
importInkText(`
=== back_in_london ===
Hello, World!
`).then(() => {
    GameStepManager.callLabel("back_in_london", {})
})
```


# Function: importJson() (/pixi-vn-ink/index/functions/importJson)



\> **importJson**(`data`): `Promise`\<`void`>

Defined in: [src/loader/importer.ts:55](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/loader/importer.ts#L55)

This function imports data in PixiVNJson format into the Pixi’VN engine.

## Parameters [#parameters]

### data [#data]

[`PixiVNJson`](/pixi-vn-ink/index/interfaces/PixiVNJson) | [`PixiVNJson`](/pixi-vn-ink/index/interfaces/PixiVNJson)\[]

data in PixiVNJson format

## Returns [#returns]

`Promise`\<`void`>

the same data passed as parameter


# Function: onInkHashtagScript() (deprecated) (/pixi-vn-ink/index/functions/onInkHashtagScript)



\> **onInkHashtagScript**(`runCustomHashtagScript`): `void`

Defined in: [src/handlers/hashtag-commands.ts:515](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L515)

## Parameters [#parameters]

### runCustomHashtagScript [#runcustomhashtagscript]

[`HashtagHandler`](/pixi-vn-ink/index/type-aliases/HashtagHandler)

## Returns [#returns]

`void`

## Deprecated [#deprecated]

This function is deprecated, use [HashtagCommands.add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add) instead


# Function: onInkTranslate() (/pixi-vn-ink/index/functions/onInkTranslate)



\> **onInkTranslate**(`t`): `void`

Defined in: [src/functions/translate.ts:19](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/functions/translate.ts#L19)

This function set the function to translate the text

## Parameters [#parameters]

### t [#t]

(`text`) => `string`

The function to translate the text

## Returns [#returns]

`void`

## Example [#example]

```ts
import { onInkTranslate } from 'pixi-vn-ink'
import { useTranslation } from "react-i18next";

const { t } = useTranslation(["narration"]);
onInkTranslate((text) => {
   return t(text)
})
```


# Function: onReplaceTextAfterTranslation() (deprecated) (/pixi-vn-ink/index/functions/onReplaceTextAfterTranslation)



\> **onReplaceTextAfterTranslation**(`getTextToReplace`): `void`

Defined in: [src/functions/replace.ts:30](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/functions/replace.ts#L30)

## Parameters [#parameters]

### getTextToReplace [#gettexttoreplace]

(`key`) => `string` | `undefined`

The function to get the text to replace

## Returns [#returns]

`void`

## Deprecated [#deprecated]

Use [TextReplaces](/pixi-vn-ink/index/namespaces/TextReplaces) instead.

This function is called after the [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate) function is called.
It will replace the text between square brackets.
It can be used for example to replace the character id with the character name:
If there are a character with a name "John" and id "john", and the text is "Hello, my name is \[john]",
the following function will return "Hello, my name is John"

## Example [#example]

```ts
import { onReplaceTextAfterTranslation } from 'pixi-vn-ink'
import { getCharacterById } from "@drincs/pixi-vn";

onReplaceTextAfterTranslation((key) => {
    let character = getCharacterById(key)
    if (character) {
        return character.name
    }

    // if return undefined, the system will not replace the character id
    return undefined
})
```


# Function: onReplaceTextBeforeTranslation() (deprecated) (/pixi-vn-ink/index/functions/onReplaceTextBeforeTranslation)



\> **onReplaceTextBeforeTranslation**(`getTextToReplace`): `void`

Defined in: [src/functions/replace.ts:71](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/functions/replace.ts#L71)

## Parameters [#parameters]

### getTextToReplace [#gettexttoreplace]

(`key`) => `string` | `undefined`

The function to get the text to replace

## Returns [#returns]

`void`

## Deprecated [#deprecated]

Use [TextReplaces](/pixi-vn-ink/index/namespaces/TextReplaces) instead.

This function is called before the [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate) function is called.
It will replace the text between square brackets.
It can be used for example to replace the normal method for replacing the text \[key] with a new method to replace the text \{\{key}}.
It can be used for example to optimize the text replacement with i18next, using the [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate) function.
If there are a text is "Hello, my name is \[john]", the following function will return "Hello, my name is \{\{john}}"

## Example [#example]

```ts
import { onReplaceTextBeforeTranslation, onInkTranslate } from 'pixi-vn-ink'
import { useTranslation } from "react-i18next";
import { john } from "../values/characters"

const { t } = useTranslation(["narration"]);

onInkTranslate((text) => {
    return t(text, {
        john: john.name
    })
})

onReplaceTextBeforeTranslation((key) => {
    return `{{${key}}}`
})
```


# index (/pixi-vn-ink/index)



## Namespaces [#namespaces]

* [HashtagCommands](/pixi-vn-ink/index/namespaces/HashtagCommands)
* [TextReplaces](/pixi-vn-ink/index/namespaces/TextReplaces)
* [VariableGetter](/pixi-vn-ink/index/namespaces/VariableGetter)

## Interfaces [#interfaces]

* [BaseHashtagCommandsOptions](/pixi-vn-ink/index/interfaces/BaseHashtagCommandsOptions)
* [HashtagHandlerOptions](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)
* [PixiVNJson](/pixi-vn-ink/index/interfaces/PixiVNJson)

## Type Aliases [#type-aliases]

* [CharacterIdSource](/pixi-vn-ink/index/type-aliases/CharacterIdSource)
* [HashtagHandler](/pixi-vn-ink/index/type-aliases/HashtagHandler)
* [MapperHandler](/pixi-vn-ink/index/type-aliases/MapperHandler)
* [ReplaceHandler](/pixi-vn-ink/index/type-aliases/ReplaceHandler)
* [ReplaceHandlerOptions](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions)

## Functions [#functions]

* [addBaseHashtagCommands](/pixi-vn-ink/index/functions/addBaseHashtagCommands)
* [convertInkText](/pixi-vn-ink/index/functions/convertInkText)
* [generateJsonInkTranslation](/pixi-vn-ink/index/functions/generateJsonInkTranslation)
* [importInkText](/pixi-vn-ink/index/functions/importInkText)
* [importJson](/pixi-vn-ink/index/functions/importJson)
* [~~onInkHashtagScript~~](/pixi-vn-ink/index/functions/onInkHashtagScript)
* [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate)
* [~~onReplaceTextAfterTranslation~~](/pixi-vn-ink/index/functions/onReplaceTextAfterTranslation)
* [~~onReplaceTextBeforeTranslation~~](/pixi-vn-ink/index/functions/onReplaceTextBeforeTranslation)

## References [#references]

### convertInkToJson [#convertinktojson]

Renames and re-exports [convertInkText](/pixi-vn-ink/index/functions/convertInkText)


# Interface: BaseHashtagCommandsOptions (/pixi-vn-ink/index/interfaces/BaseHashtagCommandsOptions)



Defined in: [src/handlers/hashtag-commands.ts:558](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L558)

Options for [addBaseHashtagCommands](/pixi-vn-ink/index/functions/addBaseHashtagCommands).

## Properties [#properties]

### assetAliasIds? [#assetaliasids]

\> `optional` **assetAliasIds?**: readonly `string`\[]

Defined in: [src/handlers/hashtag-commands.ts:571](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L571)

Known asset aliases — e.g. `assetAliasIds` from the same generated file. When provided,
`# load assets <alias...>` / `# lazyload assets <alias...>` do a runtime membership check
instead of accepting any string.

***

### bundleIds? [#bundleids]

\> `optional` **bundleIds?**: readonly `string`\[]

Defined in: [src/handlers/hashtag-commands.ts:565](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L565)

Known asset bundle names — e.g. `bundleIds` from the file generated by `vitePluginPixivn`'s
`assetsManifest` option. When provided, `# load bundle <alias...>` /
`# lazyload bundle <alias...>` do a runtime membership check instead of accepting any
string.

***

### sections? [#sections]

\> `optional` **sections?**: `BaseHashtagCommandsSections`

Defined in: [src/handlers/hashtag-commands.ts:577](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L577)

Which of the four built-in groups to actually register — see
BaseHashtagCommandsSections. Any section left unset (or `sections` itself left
unset) defaults to `true`.


# Interface: HashtagHandlerOptions (/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)



Defined in: [src/handlers/interfaces/HashtagHandler.ts:69](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L69)

Configuration options for a Hashtag-Command handler registered via [HashtagCommands.add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add).

## Properties [#properties]

### deprecated? [#deprecated]

\> `optional` **deprecated?**: `boolean`

Defined in: [src/handlers/interfaces/HashtagHandler.ts:103](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L103)

Whether this handler is deprecated. Deprecated handlers should still function correctly
but may be replaced by newer alternatives in the future.

***

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/handlers/interfaces/HashtagHandler.ts:79](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L79)

An optional human-readable description of what this handler does.
Used for documentation purposes. Supports multi-line descriptions.

***

### keySchemas? [#keyschemas]

\> `optional` **keySchemas?**: `Record`\<`string` | `number`, `object`>

Defined in: [src/handlers/interfaces/HashtagHandler.ts:143](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L143)

JSON Schemas (usable with Ajv) for order-independent `<key> <value> [<value2> ...]` sections
embedded anywhere in the command's token list, keyed by the token that introduces the
section.

[validation](#validation) can only check the token list's own shape (fixed positions, or "any
number of trailing strings"); it can't express that everything after a given key must parse
into an object matching a specific JSON Schema. `keySchemas` fills that gap and — unlike
[validation](#validation) — is meant to be checked statically (by `vitePluginPixivn` / the VS Code
extension) without running the handler.

Each key in `keySchemas` is matched against the command's tokens from right to left: the
right-most occurrence of any known key starts a section that runs to the end of the
still-unprocessed tail; the scan then continues to its left for the next key, and so on.
Each section's tokens are converted to an object with the same `<key> <value>` pairing logic
as `convertListStringToObj` (passed to [HashtagHandler](/pixi-vn-ink/index/type-aliases/HashtagHandler)), then validated against that
key's schema.

#### Examples [#examples]

```ts
For the command `# wait hours 3 days tomorrow`, tokens are
`["wait", "hours", "3", "days", "tomorrow"]`. With
`keySchemas: { wait: { type: "object", properties: { hours: { type: "number" }, days: { type: "string" } } } }`,
the right-most (and only) match is `"wait"` at index 0; everything after it —
`{ hours: 3, days: "tomorrow" }` — is validated against that schema.
```

```ts
For `# show imagecontainer sly props xAlign 0.2 yAlign 1 movein direction right ease anticipate`
with `keySchemas: { props: propsSchema, movein: moveinSchema }`, the scan finds `"movein"`
first (right-most), validates `{ direction: "right", ease: "anticipate" }` against
`moveinSchema`, then continues left to `"props"` and validates
`{ xAlign: 0.2, yAlign: 1 }` against `propsSchema`.

A key can also be a number (or a digit-only string — object keys are always strings at
runtime). Numeric keys are checked only after every string key has already claimed its
section, largest to smallest, counting from `0` at the command's own leading literal (e.g.
`"show"`): key `N` claims `tokens[N .. end)` — `end` being the left edge of whatever the
previous (string or numeric) match already claimed — and the token right before it
(`tokens[N - 1]`, e.g. a dynamic alias no literal key could match) is dropped along with it.
See {@link InkHashtagCommandInfo.keySchemas} for a full worked example.
```

***

### name [#name]

\> **name**: `string`

Defined in: [src/handlers/interfaces/HashtagHandler.ts:74](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L74)

A unique name that identifies this handler.
Used for documentation and debugging purposes.

***

### validation [#validation]

\> **validation**: `RegExp` | `ZodType`\<`string`\[], `unknown`, `$ZodTypeInternals`\<`string`\[], `unknown`>>

Defined in: [src/handlers/interfaces/HashtagHandler.ts:98](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L98)

Determines whether this handler should be invoked for a given command.

* `RegExp` – the command tokens are joined with a space (`script.join(" ")`) and tested
  against the regular expression. The handler is invoked only if the regex matches.
* `ZodType<string[]>` – the command token array is validated with
  `schema.safeParse(script)`. The handler is invoked only if validation succeeds.

#### Example [#example]

```ts
// RegExp: only handle commands that start with "navigate"
validation: /^navigate\b/

// Zod: only handle commands whose first element is "navigate" and second is a non-empty string
import { z } from "zod"
validation: z.tuple([z.literal("navigate"), z.string().min(1)]).rest(z.string())
```


# Interface: PixiVNJson (/pixi-vn-ink/index/interfaces/PixiVNJson)



Defined in: node_modules/@drincs/pixi-vn-json/dist/schema.d.ts:19

PixiVNJson It can be defined as a programming language to write a narrative written in json.

## Properties [#properties]

### $schema? [#schema]

\> `optional` **$schema?**: `string`

Defined in: node_modules/@drincs/pixi-vn-json/dist/schema.d.ts:30

The URI of the JSON Schema that describes and validates this document.

You can point to a specific version of the schema, for example:

* `"https://pixi-vn.com/schemas/1.13.0/schema.json"` — pin to a specific version
* `"https://pixi-vn.com/schemas/latest/schema.json"` — always use the latest version

Most editors (VS Code, WebStorm, etc.) use this field to provide
auto-completion, hover documentation, and validation for the document.

***

### initialOperations? [#initialoperations]

\> `optional` **initialOperations?**: (`PixiVNJsonValueSet` | `PixiVNJsonIfElse`\<`PixiVNJsonValueSet`>)\[]

Defined in: node_modules/@drincs/pixi-vn-json/dist/schema.d.ts:36

The operations to be executed before the narrative starts.
For the set storage: They will be set only if there are no variables with the same key already.
For the det tempstorage: if there are variables with the same key already, they will be overwritten.

***

### labels? [#labels]

\> `optional` **labels?**: `PixiVNJsonLabels`

Defined in: node_modules/@drincs/pixi-vn-json/dist/schema.d.ts:40

The labels to be used in the narrative. They will be added to the system


# Function: add() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add)



## Call Signature [#call-signature]

\> **add**(`handler`): `void`

Defined in: [src/handlers/hashtag-commands.ts:65](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L65)

### Parameters [#parameters]

#### handler [#handler]

[`HashtagHandler`](/pixi-vn-ink/index/type-aliases/HashtagHandler)

### Returns [#returns]

`void`

### Deprecated [#deprecated]

Use the two-parameter overload with [HashtagHandlerOptions](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions) instead.

## Call Signature [#call-signature-1]

\> **add**(`handler`, `opts`): `void`

Defined in: [src/handlers/hashtag-commands.ts:90](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L90)

This function add a new handler (middleware) that will be called before the system interprets a possible Hashtag-Command that starts with `#`.
The developer can use this function to run a custom Hashtag-Command. If the function returns `true`, the system will not interpret the Hashtag-Command.
If returns a array of strings, the system will interpret the array as a new Hashtag-Command.

### Parameters [#parameters-1]

#### handler [#handler-1]

[`HashtagHandler`](/pixi-vn-ink/index/type-aliases/HashtagHandler)

The handler to run a custom Hashtag-Command

#### opts [#opts]

[`HashtagHandlerOptions`](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)

Configuration for this handler, including its name, optional description, and validation rule.

### Returns [#returns-1]

`void`

### Example [#example]

```ts title="content/ink/hashtag-commands.ts"
import { HashtagCommands } from 'pixi-vn-ink'

HashtagCommands.add((script, props, convertListStringToObj) => {
   // script: # navigate scene_name prop1 "value 1" prop2 "value 2"
   if (script[0] === "navigate" && script.length > 1) {
       let prop = undefined
       if (script.length > 2) {
           prop = convertListStringToObj(script.slice(2))
       }
       navigateTo(script[1], prop)
       return true
   }
   return false
}, { name: "navigate-command", validation: /^navigate\b/ })
```


# Function: addMapper() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/addMapper)



\> **addMapper**(`handler`, `opts`): `void`

Defined in: [src/handlers/hashtag-commands.ts:146](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L146)

Registers a new mapper that converts a specific Hashtag-Command pattern into a
PixiVNJsonOperation.

Mappers are evaluated in registration order by
[HashtagCommands.convertOperation](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertOperation) **before** the built-in `switch` table.  The
first mapper whose [HashtagHandlerOptions.validation](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions#validation) matches the raw token list is
called and its return value is used as the operation; subsequent mappers (and the built-in
switch) are skipped.

Use `addMapper` instead of [add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add) when you want to extend or override the built-in
command → operation translation without intercepting the full handler pipeline.

## Parameters [#parameters]

### handler [#handler]

[`MapperHandler`](/pixi-vn-ink/index/type-aliases/MapperHandler)

A [MapperHandler](/pixi-vn-ink/index/type-aliases/MapperHandler) that receives the full token list and the current
step, and returns either a PixiVNJsonOperation or `undefined`.

### opts [#opts]

[`HashtagHandlerOptions`](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)

Configuration including a name, optional description, and the validation rule
used to select this mapper.

## Returns [#returns]

`void`

## Example [#example]

```ts title="content/ink/hashtag-commands.ts"
import { HashtagCommands } from 'pixi-vn-ink'
import { z } from 'zod'

// Handle: # navigate scene_name
HashtagCommands.addMapper(
    (list, step) => {
        step.labelToOpen = { label: list[1], type: "jump" }
        step.goNextStep = undefined
        return undefined
    },
    {
        name: "navigate-command",
        validation: z.tuple([z.literal("navigate"), z.string()]),
    },
)
```


# Function: clear() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/clear)



\> **clear**(): `void`

Defined in: [src/handlers/hashtag-commands.ts:153](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L153)

This function clear all the handlers added with the [add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add) function.

## Returns [#returns]

`void`


# Function: clearMappers() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/clearMappers)



\> **clearMappers**(): `void`

Defined in: [src/handlers/hashtag-commands.ts:163](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L163)

Removes all mapper handlers registered with [addMapper](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/addMapper).

Useful in tests to reset the mapper state between test cases, or in applications that need
to replace the default mappers with a custom set.

## Returns [#returns]

`void`


# Function: convertListStringToObj() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertListStringToObj)



\> **convertListStringToObj**(`list`): `Record`\<`string`, `unknown`>

Defined in: [src/handlers/hashtag-commands.ts:329](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L329)

For example:
Into Ink text:
duration 3 name "C J" surname Smith position "\{ x: 2, y 3 }"
into string list:
\["duration", "3", "x", "2", "y", "3", "name", "C J", "surname", "Smith", "position", "\{ x: 2, y 3 }"]
into object:
\{ "duration": 3, "x": 2, "y": 3, "name": "C J", "surname": "Smith", "position": \{ x: 2, y 3 } }

## Parameters [#parameters]

### list [#list]

`string`\[]

## Returns [#returns]

`Record`\<`string`, `unknown`>


# Function: convertOperation() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertOperation)



\> **convertOperation**(`list`, `step`, `options?`): `PixiVNJsonOperation` | `undefined`

Defined in: [src/handlers/hashtag-commands.ts:281](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L281)

## Parameters [#parameters]

### list [#list]

`string`\[]

### step [#step]

`PixiVNJsonLabelStep`

### options? [#options]

#### silent? [#silent]

`boolean`

When `true`, suppresses the "The operation is not valid" error log on a mapper
miss. Callers that only speculatively probe the built-in `.addMapper()` table —
e.g. to decide whether a hashtag script can be resolved eagerly at parse time,
before falling back to a deferred `operationtoconvert` step that will later be
resolved through the full [run](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/run) pipeline (custom `.add()` handlers included)
— should pass `silent: true`. Otherwise every hashtag command registered only via
`.add()` (never a mapper) would log a false "not valid" error on every parse, even
though it resolves correctly once `run()` reaches it.

## Returns [#returns]

`PixiVNJsonOperation` | `undefined`


# Function: convertTagTolist() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertTagTolist)



\> **convertTagTolist**(`tag`, `options?`): `string`\[]

Defined in: [src/handlers/hashtag-commands.ts:199](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L199)

## Parameters [#parameters]

### tag [#tag]

`string`

### options? [#options]

#### mergeInkVariables? [#mergeinkvariables]

`boolean`

## Returns [#returns]

`string`\[]


# Function: info() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/info)



\> **info**(): [`HashtagHandlerOptions`](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)\[]

Defined in: [src/handlers/hashtag-commands.ts:105](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L105)

This function returns an array of all the registered handlers with their configuration. It can be used to get information about the registered handlers, for example, to display a list of available Hashtag-Commands in a debug menu.

## Returns [#returns]

[`HashtagHandlerOptions`](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions)\[]

An array of all the registered handlers with their configuration.


# Function: mergeJsonBlocks() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/mergeJsonBlocks)



\> **mergeJsonBlocks**(`tokens`): `string`\[]

Defined in: [src/handlers/hashtag-commands.ts:415](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L415)

Merges valid JSON-like blocks delimited by \{ }
into single strings.

Rules:

* Braces must be balanced.
* Inner blocks are processed before parent blocks.
* Every generated block is validated with JSON5.parse().
* If a block is invalid:
  * the block remains split
  * all parent blocks also remain split
* Unmatched braces are treated as normal strings.

## Parameters [#parameters]

### tokens [#tokens]

`string`\[]

## Returns [#returns]

`string`\[]


# Function: run() (/pixi-vn-ink/index/namespaces/HashtagCommands/functions/run)



\> **run**(`tag`, `step`, `props`): `Promise`\<`PixiVNJsonOperation` | `undefined`>

Defined in: [src/handlers/hashtag-commands.ts:174](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/hashtag-commands.ts#L174)

This function run the Hashtag-Command, it will be called before running the step. It will interpret the Hashtag-Command and return the corresponding operation to run before the step. If the Hashtag-Command is not valid, it will return undefined and the system will run the step normally.

## Parameters [#parameters]

### tag [#tag]

`string`

The Hashtag-Command to interpret, it is the string that starts with `#` and is followed by the operation type and its parameters.

### step [#step]

`PixiVNJsonLabelStep`

The step that will be run after the Hashtag-Command, the system will run the Hashtag-Command before running the step, so the operation returned by this function will be executed before the step. The step can be modified by the Hashtag-Command, for example, it can change the dialogue or the goNextStep properties of the step.

### props [#props]

`StepLabelProps`

The properties of the step label, it can be used to get information about the step and the label, for example, the label name or the step index. It can also be used to store custom properties that can be accessed by the handlers of the Hashtag-Command.

## Returns [#returns]

`Promise`\<`PixiVNJsonOperation` | `undefined`>

The operation to run before the step, if the Hashtag-Command is not valid, it will return undefined and the system will run the step normally.


# HashtagCommands (/pixi-vn-ink/index/namespaces/HashtagCommands)



This is a container for the functions related to the Hashtag-Command, a system that allows to run custom operations from the Ink command using a special syntax. The Hashtag-Command is a string that starts with `#` and is followed by the operation type and its parameters. The system will interpret the Hashtag-Command and run the corresponding operation before running the step. The developer can also add custom handlers to run custom operations from the Hashtag-Command using the [add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add) function.

## Functions [#functions]

* [add](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/add)
* [addMapper](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/addMapper)
* [clear](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/clear)
* [clearMappers](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/clearMappers)
* [convertListStringToObj](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertListStringToObj)
* [convertOperation](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertOperation)
* [convertTagTolist](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertTagTolist)
* [info](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/info)
* [mergeJsonBlocks](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/mergeJsonBlocks)
* [run](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/run)


# Function: add() (/pixi-vn-ink/index/namespaces/TextReplaces/functions/add)



\> **add**(`fn`, `handlerOptions`): `void`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:167

Registers a new replacement handler.

Handlers are executed in the order they are added. The first handler added runs first.

The TranslatorManager translation pipeline automatically calls
[TextReplaces.replace](/pixi-vn-ink/index/namespaces/TextReplaces/functions/replace) for both phases (`"before-translation"` and
`"after-translation"`), so no additional setup is required after calling `add`.

## Parameters [#parameters]

### fn [#fn]

[`ReplaceHandler`](/pixi-vn-ink/index/type-aliases/ReplaceHandler)

The handler function. Receives the key found inside `[...]` and should return
the replacement string, or `undefined` to leave that token unchanged.

### handlerOptions [#handleroptions]

[`ReplaceHandlerOptions`](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions)

Configuration for this handler, including its name, optional
description, validation regex, and execution phase.

## Returns [#returns]

`void`

## Example [#example]

```ts title="content/text-replaces.ts"
import { TextReplaces } from 'pixi-vn-ink'

TextReplaces.add(
    (key) => key === "player" ? "Mario" : undefined,
    {
        name: "player-name",
        validation: /^player$/,
    }
)
```


# Function: info() (/pixi-vn-ink/index/namespaces/TextReplaces/functions/info)



\> **info**(): [`ReplaceHandlerOptions`](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions)\[]

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:182

Returns metadata for all registered handlers, in registration order.

## Returns [#returns]

[`ReplaceHandlerOptions`](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions)\[]

An array of [ReplaceHandlerOptions](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions) for each registered handler.


# Function: remove() (/pixi-vn-ink/index/namespaces/TextReplaces/functions/remove)



\> **remove**(`fn`): `void`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:176

Removes a previously registered handler function.

Only the first registration matching `fn` is removed. If the same function was added
multiple times, subsequent registrations remain.

## Parameters [#parameters]

### fn [#fn]

[`ReplaceHandler`](/pixi-vn-ink/index/type-aliases/ReplaceHandler)

The handler function to remove.

## Returns [#returns]

`void`


# Function: replace() (/pixi-vn-ink/index/namespaces/TextReplaces/functions/replace)



\> **replace**(`text`, `replaceOptions`): `string`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:201

Applica tutti gli handler registrati del tipo specificato al testo dato.

Questa funzione NON esegue più la pre-elaborazione i18n automaticamente.
Se vuoi applicare la pre-elaborazione i18n, usa prima [runI18nPreStep](/pixi-vn-ink/index/namespaces/TextReplaces/functions/runI18nPreStep) sul testo.

## Parameters [#parameters]

### text [#text]

`string`

Il testo sorgente da processare.

### replaceOptions [#replaceoptions]

Specifica quale fase di handler eseguire.

#### type [#type]

`"before-translation"` | `"after-translation"`

Quale fase di handler eseguire.

## Returns [#returns]

`string`

Il testo dopo che tutti gli handler sono stati applicati.

## Example [#example]

```ts
// Solo handler di tipo "before-translation"
TextReplaces.replace("Ciao [name]", { type: "before-translation" })

// Con pre-elaborazione i18n:
let t = TextReplaces.runI18nPreStep("Ciao [name]");
t = TextReplaces.replace(t, { type: "before-translation" });
```


# Function: runI18nPreStep() (/pixi-vn-ink/index/namespaces/TextReplaces/functions/runI18nPreStep)



\> **runI18nPreStep**(`text`): `string`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:217

Esegue la pre-elaborazione i18n su tutti gli handler registrati con `i18nInterpolation: true`.

Per ogni handler con questa opzione, la prima occorrenza di ogni `[key]` valida viene sostituita con `{{[key]}}`.

## Parameters [#parameters]

### text [#text]

`string`

Il testo da processare.

## Returns [#returns]

`string`

Il testo dopo la pre-elaborazione i18n.

## Example [#example]

```ts
// Pre-elabora tutte le variabili i18n:
const pre = TextReplaces.runI18nPreStep("Ciao [name]");
```


# TextReplaces (/pixi-vn-ink/index/namespaces/TextReplaces)



Manages text replacement handlers that process content enclosed in square brackets (`[key]`).

Handlers are called in the order they were added. For each handler, the current text is scanned
for all `[key]` patterns. If the handler's `validation` matches a key, the handler is
invoked with that key. If the handler returns a string, all occurrences of `[key]` are replaced
with the returned value. After a handler finishes processing the text, the next handler starts
on the updated text.

Each handler specifies whether it runs before or after translation via the `type` field in its
options (defaults to `"after-translation"`).

## Example [#example]

```ts title="content/text-replaces.ts"
import { TextReplaces } from 'pixi-vn-ink'
import { getCharacterById } from "@drincs/pixi-vn";

// Replace [characterId] with the character's display name
TextReplaces.add(
    (key) => {
        const character = getCharacterById(key)
        return character?.name
    },
    {
        name: "character-name",
        description: "Replaces character IDs with their display names",
        validation: /^[a-z_]+$/,
        type: "after-translation",
    }
)
// "Hello [john], meet [jane]!" -> "Hello John, meet Jane!"
```

## Variables [#variables]

* [options](/pixi-vn-ink/index/namespaces/TextReplaces/variables/options)

## Functions [#functions]

* [add](/pixi-vn-ink/index/namespaces/TextReplaces/functions/add)
* [info](/pixi-vn-ink/index/namespaces/TextReplaces/functions/info)
* [remove](/pixi-vn-ink/index/namespaces/TextReplaces/functions/remove)
* [replace](/pixi-vn-ink/index/namespaces/TextReplaces/functions/replace)
* [runI18nPreStep](/pixi-vn-ink/index/namespaces/TextReplaces/functions/runI18nPreStep)


# Variable: options (/pixi-vn-ink/index/namespaces/TextReplaces/variables/options)



\> `const` **options**: `object`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:134

Configuration options for the `TextReplaces` system.

## Type Declaration [#type-declaration]

### replaceRegex [#replaceregex]

\> **replaceRegex**: `RegExp`

The regex used to find replacement tokens in the text (e.g. `[key]`).

#### Default [#default]

```ts
/\[([^\]]+)\]/
```


# Function: add() (/pixi-vn-ink/index/namespaces/VariableGetter/functions/add)



\> **add**(`handler`): `void`

Defined in: node_modules/@drincs/pixi-vn-json/dist/VariableGetter-ZDA6kdah.d.ts:20

Registers a new middleware handler into the resolution chain.
Handlers are invoked in the order they were added.

## Parameters [#parameters]

### handler [#handler]

`VariableGetterHandler`

The middleware handler to register.

## Returns [#returns]

`void`


# Function: clear() (/pixi-vn-ink/index/namespaces/VariableGetter/functions/clear)



\> **clear**(): `void`

Defined in: node_modules/@drincs/pixi-vn-json/dist/VariableGetter-ZDA6kdah.d.ts:24

Removes all registered middleware handlers, restoring the default resolution behaviour.

## Returns [#returns]

`void`


# Function: getLogichValue() (/pixi-vn-ink/index/namespaces/VariableGetter/functions/getLogichValue)



\> **getLogichValue**\<`T`>(`value`, `props?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn-json/dist/VariableGetter-ZDA6kdah.d.ts:33

Resolves a JSON logic value, running it through all registered middleware handlers
before falling back to the built-in storage/arithmetic/condition evaluator.

## Type Parameters [#type-parameters]

### T [#t]

`T` = `StorageElementType`

## Parameters [#parameters]

### value [#value]

`any`

The value or logic expression to resolve.

### props? [#props]

`StepLabelProps`

The current step label props passed to each handler.

## Returns [#returns]

`T` | `undefined`

The resolved value, or `undefined`.


# VariableGetter (/pixi-vn-ink/index/namespaces/VariableGetter)



## Functions [#functions]

* [add](/pixi-vn-ink/index/namespaces/VariableGetter/functions/add)
* [clear](/pixi-vn-ink/index/namespaces/VariableGetter/functions/clear)
* [getLogichValue](/pixi-vn-ink/index/namespaces/VariableGetter/functions/getLogichValue)


# Type Alias: CharacterIdSource (/pixi-vn-ink/index/type-aliases/CharacterIdSource)



\> **CharacterIdSource** = `string` | \{ `id`: `string`; }

Defined in: [src/converter/type.ts:4](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/converter/type.ts#L4)

A character id, or any object carrying one (e.g. a `CharacterInterface` / `RegisteredCharacters.values()`).


# Type Alias: HashtagHandler (/pixi-vn-ink/index/type-aliases/HashtagHandler)



\> **HashtagHandler** = (`command`, `props`, `convertListStringToObj`) => `boolean` | `string` | `Promise`\<`boolean` | `string`>

Defined in: [src/handlers/interfaces/HashtagHandler.ts:19](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L19)

A handler function invoked for each Hashtag-Command that passes the [HashtagHandlerOptions.validation](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions#validation) check.

## Parameters [#parameters]

### command [#command]

`string`\[]

The Hashtag-Command split into tokens. Corresponds to a line starting with `#`.
For example `# navigate scene_name "Hello World"` becomes `["navigate", "scene_name", "Hello World"]`.
Use `""` to embed a literal space inside a single token.

### props [#props]

`StepLabelProps`

The properties of the current step.

### convertListStringToObj [#convertliststringtoobj]

(`listParm`) => `object`

Utility function that converts an alternating key/value list into
a plain object. For example `["name", "John", "age", "20"]` → `{ name: "John", age: 20 }`.

## Returns [#returns]

`boolean` | `string` | `Promise`\<`boolean` | `string`>

* `true` – the command was handled; stop processing further handlers and skip the default interpreter.
  * A `string` – treat the returned value as a new Hashtag-Command and re-interpret it.
  * `false` / `Promise<false>` – not handled; pass to the next registered handler.


# Type Alias: MapperHandler (/pixi-vn-ink/index/type-aliases/MapperHandler)



\> **MapperHandler** = (`list`, `step`) => `PixiVNJsonOperation` | `undefined`

Defined in: [src/handlers/interfaces/HashtagHandler.ts:53](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/handlers/interfaces/HashtagHandler.ts#L53)

A mapper function that converts a specific Hashtag-Command token list into a
PixiVNJsonOperation (or `undefined` when the command only modifies the step without
producing an operation, e.g. `call` / `jump`).

Unlike [HashtagHandler](/pixi-vn-ink/index/type-aliases/HashtagHandler), a mapper is purely synchronous and is **selected** by its
validation rule rather than deciding for itself whether to handle the command.  The selection
logic in [HashtagCommands.convertOperation](/pixi-vn-ink/index/namespaces/HashtagCommands/functions/convertOperation) tests each mapper's
[HashtagHandlerOptions.validation](/pixi-vn-ink/index/interfaces/HashtagHandlerOptions#validation) against the full token list; only the first matching
mapper is called.

## Parameters [#parameters]

### list [#list]

`string`\[]

### step [#step]

`PixiVNJsonLabelStep`

## Returns [#returns]

`PixiVNJsonOperation` | `undefined`

The PixiVNJsonOperation to enqueue, or `undefined` if the command only produces
side-effects on `step` (such as setting `labelToOpen`).


# Type Alias: ReplaceHandler (/pixi-vn-ink/index/type-aliases/ReplaceHandler)



\> **ReplaceHandler** = (`key`) => `string` | `undefined`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:16

A handler function invoked for each `[key]` token found in the text that passes the
[ReplaceHandlerOptions.validation](/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions#validation) check.

## Parameters [#parameters]

### key [#key]

`string`

The content found inside the square brackets (without the brackets themselves).
For example, for the token `[john]` the key is `"john"`.

## Returns [#returns]

`string` | `undefined`

The string to substitute in place of `[key]`, or `undefined` to leave the token unchanged.


# Type Alias: ReplaceHandlerOptions (/pixi-vn-ink/index/type-aliases/ReplaceHandlerOptions)



\> **ReplaceHandlerOptions** = `object`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:24

Configuration options for a text-replacement handler registered via [TextReplaces.add](/pixi-vn-ink/index/namespaces/TextReplaces/functions/add).

## Properties [#properties]

### description? [#description]

\> `optional` **description?**: `string`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:34

An optional human-readable description of what this handler does.
Used for documentation purposes.

***

### i18nInterpolation? [#i18ninterpolation]

\> `optional` **i18nInterpolation?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:94

When `true`, the **first** occurrence of a matched `[key]` token is converted to the i18n
double-brace format `{{[key]}}` (exactly once). Any subsequent occurrences of `[key]` in
the same text are then replaced with the handler's return value as usual.

The transformation sequence for a matched key is:

* first occurrence: `[key]` → `{{[key]}}`
* remaining occurrences: `[key]` → handler return value

When `false` or omitted, the handler's return value directly replaces all occurrences of `[key]`.

**Recommended i18n configuration:** when this option is enabled, configure
`missingInterpolationHandler` in your i18n instance so that keys with no matching
translation are left intact rather than replaced with an empty string:

```ts title="lib/i18n.ts"
i18n.init({
    // ...
    missingInterpolationHandler(_text, value, _options) {
        return value[1];
    },
});
```

#### Default [#default]

```ts
false
```

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:29

A unique name that identifies this handler.
Used for documentation and debugging purposes.

***

### type? [#type]

\> `optional` **type?**: `"after-translation"` | `"before-translation"`

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:67

When this handler should be invoked relative to the translation step.

* `"before-translation"` – the handler runs **before** [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate) is called.
  Useful for pre-processing tokens, e.g. converting `[key]` into `{{key}}` for i18next.
* `"after-translation"` – the handler runs **after** [onInkTranslate](/pixi-vn-ink/index/functions/onInkTranslate) is called.
  Useful for substituting values that depend on the translated text.

#### Default [#default-1]

```ts
"after-translation"
```

***

### validation [#validation]

\> **validation**: `RegExp` | `"characterId"` | `"all"` | `ZodType`\<`string`>

Defined in: node_modules/@drincs/pixi-vn-json/dist/translator.d.ts:56

Determines whether this handler should be invoked for a given `[key]` token.

* `"all"` – the handler is always invoked for every token found.
* `"characterId"` – the handler is invoked only when the key matches a registered character ID
  (i.e. the character is present in `RegisteredCharacters`).
* `RegExp` – the key string is tested against the regular expression. The handler is invoked
  only if the regex matches.
* `ZodType<string>` – the key string is validated with `schema.safeParse(key)`. The handler
  is invoked only if validation succeeds.

#### Example [#example]

```ts
// RegExp: only replace keys that look like lowercase identifiers
validation: /^[a-z_]+$/

// Zod: only replace keys that are one of a fixed set of values
import { z } from "zod"
validation: z.enum(["player", "npc", "enemy"])
```


# @drincs/pixi-vn-ink (/pixi-vn-ink/modules)



## Modules [#modules]

* [index](/pixi-vn-ink/index)
* [vite](/pixi-vn-ink/vite)
* [vite-listener](/pixi-vn-ink/vite-listener)


# Function: setupInkHmrListener() (/pixi-vn-ink/vite-listener/functions/setupInkHmrListener)



\> **setupInkHmrListener**(`options?`): `Promise`\<`void`>

Defined in: [src/vite-listener/plugins.ts:94](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite-listener/plugins.ts#L94)

Sets up HMR listeners for live ink story reloading in the browser.

Call this once in your app entry file.
If available in your `@drincs/pixi-vn` version, call `setupPixivnViteData()`
before this function; otherwise you can safely skip that step.
Handler registration (hashtag commands, text replaces, characters, labels)
is handled server-side by `vitePluginPixivn`'s `content` / `characters` /
`labels` options — no browser POSTs are needed.

## Parameters [#parameters]

### options? [#options]

[`InkHmrListenerOptions`](/pixi-vn-ink/vite-listener/type-aliases/InkHmrListenerOptions) = `{}`

## Returns [#returns]

`Promise`\<`void`>

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Example [#example]

```ts title="main.ts"
// main.ts
import { setupInkHmrListener } from "@drincs/pixi-vn-ink/vite-listener";

const pixivnViteListener = await import("@drincs/pixi-vn/vite-listener").catch((error) => {
  const message = error instanceof Error ? error.message : String(error);
  const code =
    typeof error === "object" && error !== null && "code" in error
      ? String((error as { code?: unknown }).code)
      : "";
  if (
    code === "ERR_MODULE_NOT_FOUND" ||
    code === "ERR_PACKAGE_PATH_NOT_EXPORTED" ||
    message.includes("@drincs/pixi-vn/vite-listener")
  ) return undefined;
  throw error;
});
await pixivnViteListener?.setupPixivnViteData?.();
await setupInkHmrListener();
```


# vite-listener (/pixi-vn-ink/vite-listener)



## Type Aliases [#type-aliases]

* [InkHmrListenerOptions](/pixi-vn-ink/vite-listener/type-aliases/InkHmrListenerOptions)

## Functions [#functions]

* [setupInkHmrListener](/pixi-vn-ink/vite-listener/functions/setupInkHmrListener)


# Type Alias: InkHmrListenerOptions (/pixi-vn-ink/vite-listener/type-aliases/InkHmrListenerOptions)



\> **InkHmrListenerOptions** = `object`

Defined in: [src/vite-listener/plugins.ts:18](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite-listener/plugins.ts#L18)

Options for the Ink HMR listener helpers.

## Properties [#properties]

### characters? [#characters]

\> `optional` **characters?**: readonly [`CharacterIdSource`](/pixi-vn-ink/index/type-aliases/CharacterIdSource)\[]

Defined in: [src/vite-listener/plugins.ts:23](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite-listener/plugins.ts#L23)

Characters forwarded to [importInkText](/pixi-vn-ink/index/functions/importInkText) when an update re-imports raw Ink text (the path
used without `inkJsonOutputPattern`), so `characterId: text` speakers resolve at reload time.


# Function: vitePluginInk() (/pixi-vn-ink/vite/functions/vitePluginInk)



\> **vitePluginInk**(`options?`): `Plugin`

Defined in: [src/vite/plugins.ts:490](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L490)

Creates a Vite plugin that:

* Prevents Hot Module Replacement (HMR) for `.ink` files and instead sends an `ink-updated`
  custom event to the client so that setupInkHmrListener can reload the story.
* Transforms `.ink` files so they can be imported as plain strings.
* Optionally generates a virtual module `virtual:pixi-vn-ink` (when [VitePluginInkOptions.inkGlob](/pixi-vn-ink/vite/interfaces/VitePluginInkOptions#inkglob)
  is provided) that exports all matched ink file contents as a `string[]`, removing the need
  to write a manual glob-import helper.
* Optionally exports the same matched `.ink` files as `.json` to a configurable location
  (when [VitePluginInkOptions.inkJsonOutputPattern](/pixi-vn-ink/vite/interfaces/VitePluginInkOptions#inkjsonoutputpattern) is provided), together with a
  `manifest.json` file for bulk runtime loading with `importPixiVNJson`.

## Parameters [#parameters]

### options? [#options]

[`VitePluginInkOptions`](/pixi-vn-ink/vite/interfaces/VitePluginInkOptions)

Optional plugin configuration.

## Returns [#returns]

`Plugin`

A Vite plugin.

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Examples [#examples]

```ts title="vite.config.ts"
// vite.config.ts – without inkGlob (manual loading)
import { defineConfig } from "vite";
import { vitePluginInk } from "@drincs/pixi-vn-ink/vite";

export default defineConfig({
  plugins: [vitePluginInk()],
});
```

```ts title="vite.config.ts"
// vite.config.ts – with inkGlob (automatic loading via virtual module)
import { defineConfig } from "vite";
import { vitePluginInk } from "@drincs/pixi-vn-ink/vite";

export default defineConfig({
  plugins: [vitePluginInk({ inkGlob: "./ink/**/*.ink" })],
});
```

```ts title="main.ts"
// main.ts
import { importInkText } from "@drincs/pixi-vn-ink";
import { setupInkHmrListener } from "@drincs/pixi-vn-ink/vite-listener";
import inkTexts from "virtual:pixi-vn-ink";

await importInkText(inkTexts);
setupInkHmrListener();
```

```ts title="vite.config.ts"
// vite.config.ts – generate JSON files in public/ink-json too
import { defineConfig } from "vite";
import { vitePluginInk } from "@drincs/pixi-vn-ink/vite";

export default defineConfig({
  plugins: [
    vitePluginInk({
      inkGlob: "./ink/**/*.ink",
      inkJsonOutputPattern: "./public/ink-json/[path][name].json",
    }),
  ],
});
```

```ts title="main.ts"
// Bulk-load the generated JSON files at runtime
import { importPixiVNJson } from "@drincs/pixi-vn-json/interpreter";

const manifest = (await fetch("/ink-json/manifest.json").then((response) =>
  response.json(),
)) as string[];

const stories = await Promise.all(
  manifest.map((url) => fetch(url).then((response) => response.json())),
);

await Promise.all(stories.map((story) => importPixiVNJson(story)));
```


# vite (/pixi-vn-ink/vite)



## Interfaces [#interfaces]

* [InkHashtagCommandInfo](/pixi-vn-ink/vite/interfaces/InkHashtagCommandInfo)
* [InkLibraryInfo](/pixi-vn-ink/vite/interfaces/InkLibraryInfo)
* [InkTextReplaceInfo](/pixi-vn-ink/vite/interfaces/InkTextReplaceInfo)
* [VitePluginInkOptions](/pixi-vn-ink/vite/interfaces/VitePluginInkOptions)

## Variables [#variables]

* [INK_DEV_API_HASHTAG_COMMANDS](/pixi-vn-ink/vite/variables/INK_DEV_API_HASHTAG_COMMANDS)
* [INK_DEV_API_INFO](/pixi-vn-ink/vite/variables/INK_DEV_API_INFO)
* [INK_DEV_API_TEXT_REPLACES](/pixi-vn-ink/vite/variables/INK_DEV_API_TEXT_REPLACES)

## Functions [#functions]

* [vitePluginInk](/pixi-vn-ink/vite/functions/vitePluginInk)


# Interface: InkHashtagCommandInfo (/pixi-vn-ink/vite/interfaces/InkHashtagCommandInfo)



Defined in: [src/parser/types.ts:63](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L63)

Serializable representation of a registered HashtagCommands handler,
as exposed by the pixi-vn-ink Vite dev-server API.

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Properties [#properties]

### deprecated? [#deprecated]

\> `optional` **deprecated?**: `boolean`

Defined in: [src/parser/types.ts:105](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L105)

Whether this handler is deprecated. Matches HashtagHandlerOptions.deprecated.

***

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/parser/types.ts:71](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L71)

Human-readable description of what the handler does.

***

### keySchemas? [#keyschemas]

\> `optional` **keySchemas?**: `Record`\<`string` | `number`, `object`>

Defined in: [src/parser/types.ts:168](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L168)

JSON Schemas (usable with Ajv), keyed by the token that introduces an order-independent
`<key> <value> [<value2> ...]` section of the command's tokens. Matches
HashtagHandlerOptions.keySchemas — already plain JSON Schema objects, so no extra
serialization step is needed (unlike [validation](#validation)).

#### See [#see-1]

InkCompiler.validateKeyedJsonSchemas for how a token list is split into
sections and validated against these schemas.

#### Examples [#examples]

For the command `# wait hours 3 days tomorrow` (tokens
`["wait", "hours", "3", "days", "tomorrow"]`):

```ts
{
  name: "wait-with-options",
  validation: { type: "regexp", source: "^wait\\b", flags: "" },
  keySchemas: {
    wait: {
      type: "object",
      properties: { hours: { type: "number" }, days: { type: "string" } },
      additionalProperties: false,
    },
  },
}
```

`InkCompiler.getHashtagKeySchemaIssues` matches `"wait"` (the right-most, and only,
occurrence) and validates `{ hours: 3, days: "tomorrow" }` against its schema.

For `# show imagecontainer sly props xAlign 0.2 yAlign 1 movein direction right ease anticipate`,
with two independent sections:

```ts
keySchemas: {
  props: { type: "object", properties: { xAlign: { type: "number" }, yAlign: { type: "number" } } },
  movein: { type: "object", properties: { direction: { type: "string" }, ease: { type: "string" } } },
}
```

A key can also be a (positive integer) number — or a string made only of digits, since
object keys are always strings at runtime — instead of a literal token. Numeric keys are
resolved by **position** rather than by token identity, and are checked only after every
string key has already claimed its section (right to left, exactly as above); counting
starts at `0` for the command's own leading literal (e.g. `"show"`). Numeric keys are then
processed largest to smallest: key `N` claims `tokens[N .. end)` as its section (`end` being
the left edge of the previously-claimed section), is validated against its schema, and the
token immediately before it (`tokens[N - 1]`, e.g. a dynamic alias that can't be matched by
literal value) is dropped along with it — so the next, smaller numeric key resumes scanning
to its left.

For `# show spine flowerTop x 220 y 20 with dissolve duration 2` (tokens
`["show","spine","flowerTop","x","220","y","20","with","dissolve","duration","2"]`) with:

```ts
keySchemas: {
  with: {},
  dissolve: { type: "object", properties: { duration: { type: "number" } } },
  3: { type: "object", properties: { x: { type: "number" }, y: { type: "number" } } },
}
```

String keys are resolved first: `"dissolve"` (right-most) claims `{ duration: 2 }`, then
`"with"` claims an empty section — leaving `["show","spine","flowerTop","x","220","y","20"]`
(`"show"` is position `0`) for the numeric pass. Key `3` claims `tokens[3..7)` →
`{ x: 220, y: 20 }`, and also drops `"flowerTop"` (position `2`, the element's dynamic
alias) — nothing is left to check further left.

***

### name [#name]

\> **name**: `string`

Defined in: [src/parser/types.ts:67](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L67)

Unique name that identifies the handler.

***

### validation [#validation]

\> **validation**: `InkValidationInfo`

Defined in: [src/parser/types.ts:101](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/parser/types.ts#L101)

Serializable form of the validation rule.

#### Examples [#examples-1]

A `RegExp` validation (e.g. `/^jump\b/`) serializes to:

```ts
{ type: "regexp", source: "^jump\\b", flags: "" }
```

A Zod validation (e.g. `z.tuple([z.literal("jump"), z.string()])`) serializes to its JSON
Schema form:

```ts
{
  type: "zod",
  schema: {
    type: "array",
    prefixItems: [{ type: "string", const: "jump" }, { type: "string" }],
    minItems: 2,
    maxItems: 2,
  },
}
```

A string-literal validation (e.g. `TextReplaces`' `"all"` / `"characterId"` modes)
serializes to:

```ts
{ type: "literal", value: "all" }
```


# Interface: InkLibraryInfo (/pixi-vn-ink/vite/interfaces/InkLibraryInfo)



Defined in: [src/vite/info-types.ts:45](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L45)

Static information about a running `@drincs/pixi-vn-ink` instance, as returned by
`GET /__pixi-vn-ink/info`.

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Properties [#properties]

### schemaUrl [#schemaurl]

\> **schemaUrl**: `string`

Defined in: [src/vite/info-types.ts:54](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L54)

The JSON Schema URL (`PIXIVNJSON_SCHEMA_URL` from `@drincs/pixi-vn-json/constants`)
embedded as `$schema` in every exported `PixiVNJson` document.

***

### version [#version]

\> **version**: `string`

Defined in: [src/vite/info-types.ts:49](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L49)

This `@drincs/pixi-vn-ink` package's own version (from its `package.json`).


# Interface: InkTextReplaceInfo (/pixi-vn-ink/vite/interfaces/InkTextReplaceInfo)



Defined in: [src/vite/info-types.ts:16](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L16)

Serializable representation of a registered TextReplaces handler,
as exposed by the pixi-vn-ink Vite dev-server API.

Instances of this type are returned by
`GET /__pixi-vn-ink/text-replaces`
and accepted by
`POST /__pixi-vn-ink/text-replaces`.

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Properties [#properties]

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/vite/info-types.ts:26](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L26)

Human-readable description of what the handler does.
Matches ReplaceHandlerOptions.description.

***

### name [#name]

\> **name**: `string`

Defined in: [src/vite/info-types.ts:21](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L21)

Unique name that identifies the handler.
Matches ReplaceHandlerOptions.name.

***

### type? [#type]

\> `optional` **type?**: `"before-translation"` | `"after-translation"`

Defined in: [src/vite/info-types.ts:36](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L36)

When the handler runs relative to the translation step.
Matches ReplaceHandlerOptions.type.

#### Default [#default]

```ts
"before-translation"
```

***

### validation [#validation]

\> **validation**: `InkValidationInfo`

Defined in: [src/vite/info-types.ts:30](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L30)

Serializable form of ReplaceHandlerOptions.validation.


# Interface: VitePluginInkOptions (/pixi-vn-ink/vite/interfaces/VitePluginInkOptions)



Defined in: [src/vite/plugins.ts:337](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L337)

Options for [vitePluginInk](/pixi-vn-ink/vite/functions/vitePluginInk).

## Properties [#properties]

### characters? [#characters]

\> `optional` **characters?**: readonly `string`\[]

Defined in: [src/vite/plugins.ts:397](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L397)

Character ids to recognise when splitting `characterId: text` speakers in `.ink` files.
Characters from `vite-plugin-pixi-vn` (its `api.characters`) are picked up automatically;
use this to supply ids explicitly when it is not present.

#### Example [#example]

```ts
["alice", "james"]
```

***

### inkGlob? [#inkglob]

\> `optional` **inkGlob?**: `string`

Defined in: [src/vite/plugins.ts:355](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L355)

Glob pattern specifying which `.ink` files to scan and load automatically.

When provided, a virtual module `virtual:pixi-vn-ink` is generated and can be imported
anywhere in your app. It exports, as its default export, an array of strings (`string[]`)
containing the raw text of every matched `.ink` file.

This eliminates the need to manually write a glob-import helper such as `getInkText`.

The pattern follows the standard glob format used by
[Vite's `import.meta.glob`](https://vite.dev/guide/features#glob-import).
The plugin resolves it from Vite `root` and internally normalizes it to a root-absolute
pattern for the generated virtual module.

#### Examples [#examples]

```ts
"./ink/**/*.ink"
```

```ts
"/src/stories/**/*.ink"
```

***

### inkJsonManifestPath? [#inkjsonmanifestpath]

\> `optional` **inkJsonManifestPath?**: `string`

Defined in: [src/vite/plugins.ts:389](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L389)

Custom path (including filename) for the manifest file generated alongside the exported JSON
files.

When [VitePluginInkOptions.inkJsonOutputPattern](#inkjsonoutputpattern) is set, a `manifest.json` file listing
all exported JSON URLs is written into the output base directory by default. Use this option
to override the manifest file location and/or its name.

Relative values are resolved from Vite `root`.

#### Examples [#examples-1]

```ts
"./public/ink-json/index.json"
```

```ts
"./generated/manifest.json"
```

***

### inkJsonOutputPattern? [#inkjsonoutputpattern]

\> `optional` **inkJsonOutputPattern?**: `string`

Defined in: [src/vite/plugins.ts:375](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/plugins.ts#L375)

Output pattern for generated JSON files from matched `.ink` sources.

When provided together with [VitePluginInkOptions.inkGlob](#inkglob), each matched `.ink` file is
converted with `convertInkToJson` and written to the rendered destination.

Placeholders:

* `[name]`: filename without extension
* `[ext]`: source extension without dot
* `[extname]`: source extension with dot
* `[file]`: source path relative to the `inkGlob` static base
* `[path]`: source directory relative to the `inkGlob` static base (with trailing slash)
* `[dir]`: source directory relative to Vite `root` (with trailing slash)

Relative values are resolved from Vite `root`.

#### Examples [#examples-2]

```ts
"./public/ink-json/[path][name].json"
```

```ts
"/absolute/output/[dir][name].json"
```


# Variable: INK_DEV_API_HASHTAG_COMMANDS (/pixi-vn-ink/vite/variables/INK_DEV_API_HASHTAG_COMMANDS)



\> `const` **INK_DEV_API_HASHTAG_COMMANDS**: `"/__pixi-vn-ink/hashtag-commands"` = `"/__pixi-vn-ink/hashtag-commands"`

Defined in: [src/vite/costants.ts:21](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/costants.ts#L21)

Dev-server endpoint that exposes and accepts the list of registered
HashtagCommands handlers as [InkHashtagCommandInfo](/pixi-vn-ink/vite/interfaces/InkHashtagCommandInfo) objects.

* `GET  /__pixi-vn-ink/hashtag-commands` – returns the stored `InkHashtagCommandInfo[]` as JSON.
* `POST /__pixi-vn-ink/hashtag-commands` – replaces the stored list with the JSON body
  (`InkHashtagCommandInfo[]`). Called automatically by setupInkHmrListener on
  startup and after each HMR update.
* `InkHashtagCommandInfo.validation` serializes the original validation rule:
  * `{ type: "regexp", source, flags }`
  * `{ type: "zod", schema }` (JSON Schema generated from Zod)
  * `{ type: "literal", value }`

## Example [#example]

```ts
// VS Code extension reading the registered handlers
const res = await fetch("http://localhost:5173/__pixi-vn-ink/hashtag-commands");
const commands: InkHashtagCommandInfo[] = await res.json();
```


# Variable: INK_DEV_API_INFO (/pixi-vn-ink/vite/variables/INK_DEV_API_INFO)



\> `const` **INK_DEV_API_INFO**: `"/__pixi-vn-ink/info"` = `"/__pixi-vn-ink/info"`

Defined in: [src/vite/costants.ts:64](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/costants.ts#L64)

Dev-server endpoint that exposes static information about this library instance, as an
[InkLibraryInfo](/pixi-vn-ink/vite/interfaces/InkLibraryInfo) object.

* `GET /__pixi-vn-ink/info` – returns `{ version, schemaUrl }`, where `version` is this
  `@drincs/pixi-vn-ink` package's own version and `schemaUrl` is the `PIXIVNJSON_SCHEMA_URL`
  (from `@drincs/pixi-vn-json/constants`) embedded as `$schema` in every exported `PixiVNJson`
  document.
* Read-only: unlike [INK_DEV_API_HASHTAG_COMMANDS](/pixi-vn-ink/vite/variables/INK_DEV_API_HASHTAG_COMMANDS) / [INK_DEV_API_TEXT_REPLACES](/pixi-vn-ink/vite/variables/INK_DEV_API_TEXT_REPLACES),
  there is no `POST` — both values are static per plugin instance and don't depend on
  SSR-loading the user's content, so there's nothing for setupInkHmrListener to push.

## Example [#example]

```ts
// VS Code extension reading the library version / schema URL
const res = await fetch("http://localhost:5173/__pixi-vn-ink/info");
const { version, schemaUrl }: InkLibraryInfo = await res.json();
```


# Variable: INK_DEV_API_TEXT_REPLACES (/pixi-vn-ink/vite/variables/INK_DEV_API_TEXT_REPLACES)



\> `const` **INK_DEV_API_TEXT_REPLACES**: `"/__pixi-vn-ink/text-replaces"` = `"/__pixi-vn-ink/text-replaces"`

Defined in: [src/vite/costants.ts:43](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/costants.ts#L43)

Dev-server endpoint that exposes and accepts the list of registered
TextReplaces handlers as [InkTextReplaceInfo](/pixi-vn-ink/vite/interfaces/InkTextReplaceInfo) objects.

* `GET  /__pixi-vn-ink/text-replaces` – returns the stored `InkTextReplaceInfo[]` as JSON.
* `POST /__pixi-vn-ink/text-replaces` – replaces the stored list with the JSON body
  (`InkTextReplaceInfo[]`). Called automatically by setupInkHmrListener on
  startup and after each HMR update.
* `InkTextReplaceInfo.validation` serializes the original validation rule:
  * `{ type: "regexp", source, flags }`
  * `{ type: "zod", schema }` (JSON Schema generated from Zod)
  * `{ type: "literal", value }` for string modes like `"all"` / `"characterId"`

## Example [#example]

```ts
// VS Code extension reading the registered text-replace handlers
const res = await fetch("http://localhost:5173/__pixi-vn-ink/text-replaces");
const replaces: InkTextReplaceInfo[] = await res.json();
```


# Navigation Quest Time Routine (NQTR) (/nqtr)



![cover](https://github.com/user-attachments/assets/9b514c5c-8243-4cdd-9129-ca5e45caec62)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/nqtr?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/nqtr" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/nqtr" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/nqtr?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/nqtr" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

**What is NQTR?** NQTR (Navigation Quest Time Routine) is an extension for Pixi’VN that adds advanced systems for navigation, quests, time management, and game state handling. It is fully customizable and extensible, enabling developers to implement complex game mechanics with ease.

## Installation [#installation]

If you are starting a new Pixi’VN project, it is recommended to use one of the [templates](https://pixi-vn.com/start#project-initialization) that already include NQTR.

To install the NQTR package in an existing JavaScript project, use one of the following commands:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @drincs/nqtr
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @drincs/nqtr
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @drincs/nqtr
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @drincs/nqtr
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Features [#features]

NQTR provides the following features (the order is important):

1. [Navigation and map](https://pixi-vn.com/nqtr/navigation)
2. [Time system](https://pixi-vn.com/nqtr/time)
3. [Activity](https://pixi-vn.com/nqtr/activity)
4. [Routine](https://pixi-vn.com/nqtr/routine)
5. [Quest system](https://pixi-vn.com/nqtr/quest)


# Class: ActivityBaseModel (/nqtr/index/classes/ActivityBaseModel)



Defined in: [src/classes/activity/ActivityBaseModel.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L31)

The activity model. It is used to create an activity.

## Example [#example]

```tsx
export const nap = new ActivityModel("nap",
    (_, event) => {
        if (event) {
            event.navigate("/game")
            callLabelWithGoNavigationCallBack(napLabel, event)
        }
        else {
            console.error("Event is undefined")
        }
    },
    {
        name: "Nap",
        timeSlot: {
            from: 5,
            to: 23,
        },
        icon: "https://icon.jpg",
    }
)
```

## Extends [#extends]

* [`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass)\<[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ActivityBaseModel**(`id`, `onRun`, `props`): `ActivityBaseModel`

Defined in: [src/classes/activity/ActivityBaseModel.ts:37](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L37)

#### Parameters [#parameters]

##### id [#id]

`string`

The activity id, that must be unique.

##### onRun [#onrun]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)>

The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.

##### props [#props]

[`ActivityProps`](/nqtr/index/interfaces/ActivityProps)

The activity properties.

#### Returns [#returns]

`ActivityBaseModel`

#### Overrides [#overrides]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`constructor`](/nqtr/index/classes/ActivityStoredClass#constructor)

## Properties [#properties]

### \_onRun [#_onrun]

\> `protected` `readonly` **\_onRun**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)>

Defined in: [src/classes/activity/ActivityStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L19)

#### Inherited from [#inherited-from]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`_onRun`](/nqtr/index/classes/ActivityStoredClass#_onrun)

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Inherited from [#inherited-from-1]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`id`](/nqtr/index/classes/ActivityStoredClass#id)

## Accessors [#accessors]

### dateScheduling [#datescheduling]

#### Get Signature [#get-signature]

\> **get** **dateScheduling**(): [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L34)

Used to schedule what date it will be added and removed.

##### Returns [#returns-1]

[`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

#### Inherited from [#inherited-from-2]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`dateScheduling`](/nqtr/index/classes/ActivityStoredClass#datescheduling)

***

### disabled [#disabled]

#### Get Signature [#get-signature-1]

\> **get** **disabled**(): `boolean`

Defined in: [src/classes/activity/ActivityBaseModel.ts:63](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L63)

Whether is disabled. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-2]

`boolean`

#### Set Signature [#set-signature]

\> **set** **disabled**(`value`): `void`

Defined in: [src/classes/activity/ActivityBaseModel.ts:70](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L70)

##### Parameters [#parameters-1]

###### value [#value]

`string` | `boolean`

##### Returns [#returns-3]

`void`

***

### expired [#expired]

#### Get Signature [#get-signature-2]

\> **get** **expired**(): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L48)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

##### Returns [#returns-4]

`boolean`

#### Inherited from [#inherited-from-3]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`expired`](/nqtr/index/classes/ActivityStoredClass#expired)

***

### hidden [#hidden]

#### Get Signature [#get-signature-3]

\> **get** **hidden**(): `boolean`

Defined in: [src/classes/activity/ActivityBaseModel.ts:78](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L78)

Whether is hidden. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-5]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **hidden**(`value`): `void`

Defined in: [src/classes/activity/ActivityBaseModel.ts:85](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L85)

##### Parameters [#parameters-2]

###### value [#value-1]

`string` | `boolean`

##### Returns [#returns-6]

`void`

***

### icon [#icon]

#### Get Signature [#get-signature-4]

\> **get** **icon**(): `string` | `undefined`

Defined in: [src/classes/activity/ActivityBaseModel.ts:93](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L93)

The icon of the activity.

##### Returns [#returns-7]

`string` | `undefined`

***

### name [#name]

#### Get Signature [#get-signature-5]

\> **get** **name**(): `string`

Defined in: [src/classes/activity/ActivityBaseModel.ts:52](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L52)

The name of the activity.

##### Returns [#returns-8]

`string`

#### Set Signature [#set-signature-2]

\> **set** **name**(`value`): `void`

Defined in: [src/classes/activity/ActivityBaseModel.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityBaseModel.ts#L55)

##### Parameters [#parameters-3]

###### value [#value-2]

`string` | `undefined`

##### Returns [#returns-9]

`void`

***

### run [#run]

#### Get Signature [#get-signature-6]

\> **get** **run**(): [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

Defined in: [src/classes/activity/ActivityStoredClass.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L41)

The function that is called when the activity/commitment is runned.

##### Returns [#returns-10]

[`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

#### Inherited from [#inherited-from-4]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`run`](/nqtr/index/classes/ActivityStoredClass#run)

***

### timeSlot [#timeslot]

#### Get Signature [#get-signature-7]

\> **get** **timeSlot**(): [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L29)

Time slot in which activity/commitment will be active.

##### Returns [#returns-11]

[`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

#### Inherited from [#inherited-from-5]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`timeSlot`](/nqtr/index/classes/ActivityStoredClass#timeslot)

## Methods [#methods]

### addTempHistoryItem() [#addtemphistoryitem]

\> `protected` **addTempHistoryItem**(): `void`

Defined in: [src/classes/activity/ActivityStoredClass.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L38)

#### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-6]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`addTempHistoryItem`](/nqtr/index/classes/ActivityStoredClass#addtemphistoryitem)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-4]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-13]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-7]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`getStorageProperty`](/nqtr/index/classes/ActivityStoredClass#getstorageproperty)

***

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L55)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters-5]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

The options to check if the activity/commitment is active.

#### Returns [#returns-14]

`boolean`

#### Inherited from [#inherited-from-8]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`isActive`](/nqtr/index/classes/ActivityStoredClass#isactive)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-6]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-9]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`migrateOldStorage`](/nqtr/index/classes/ActivityStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-7]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-3]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-16]

`void`

#### Inherited from [#inherited-from-10]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`setStorageProperty`](/nqtr/index/classes/ActivityStoredClass#setstorageproperty)


# Class: ActivityStoredClass<OnRunEventType> (/nqtr/index/classes/ActivityStoredClass)



Defined in: [src/classes/activity/ActivityStoredClass.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L13)

## Extends [#extends]

* `StoredClassModel`

## Extended by [#extended-by]

* [`ActivityBaseModel`](/nqtr/index/classes/ActivityBaseModel)
* [`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass)

## Type Parameters [#type-parameters]

### OnRunEventType [#onruneventtype]

`OnRunEventType` = [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

## Implements [#implements]

* `ActivityBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ActivityStoredClass**\<`OnRunEventType`>(`id`, `_onRun`, `props`, `category?`): `ActivityStoredClass`\<`OnRunEventType`>

Defined in: [src/classes/activity/ActivityStoredClass.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L17)

#### Parameters [#parameters]

##### id [#id]

`string`

##### \_onRun [#_onrun]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`OnRunEventType`>

##### props [#props]

[`ActivityStoredClassProps`](/nqtr/index/interfaces/ActivityStoredClassProps)

##### category? [#category]

`string` = `ACTIVITY_CATEGORY`

#### Returns [#returns]

`ActivityStoredClass`\<`OnRunEventType`>

#### Overrides [#overrides]

`StoredClassModel.constructor`

## Properties [#properties]

### \_onRun [#_onrun-1]

\> `protected` `readonly` **\_onRun**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`OnRunEventType`>

Defined in: [src/classes/activity/ActivityStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L19)

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`ActivityBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`StoredClassModel.id`

## Accessors [#accessors]

### dateScheduling [#datescheduling]

#### Get Signature [#get-signature]

\> **get** **dateScheduling**(): [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L34)

Used to schedule what date it will be added and removed.

##### Returns [#returns-1]

[`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

#### Implementation of [#implementation-of-1]

`ActivityBaseInternalInterface.dateScheduling`

***

### expired [#expired]

#### Get Signature [#get-signature-1]

\> **get** **expired**(): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L48)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

##### Returns [#returns-2]

`boolean`

#### Implementation of [#implementation-of-2]

`ActivityBaseInternalInterface.expired`

***

### run [#run]

#### Get Signature [#get-signature-2]

\> **get** **run**(): [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

Defined in: [src/classes/activity/ActivityStoredClass.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L41)

The function that is called when the activity/commitment is runned.

##### Returns [#returns-3]

[`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

#### Implementation of [#implementation-of-3]

`ActivityBaseInternalInterface.run`

***

### timeSlot [#timeslot]

#### Get Signature [#get-signature-3]

\> **get** **timeSlot**(): [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L29)

Time slot in which activity/commitment will be active.

##### Returns [#returns-4]

[`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

#### Implementation of [#implementation-of-4]

`ActivityBaseInternalInterface.timeSlot`

## Methods [#methods]

### addTempHistoryItem() [#addtemphistoryitem]

\> `protected` **addTempHistoryItem**(): `void`

Defined in: [src/classes/activity/ActivityStoredClass.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L38)

#### Returns [#returns-5]

`void`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-1]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-6]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-1]

`StoredClassModel.getStorageProperty`

***

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L55)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters-2]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

The options to check if the activity/commitment is active.

#### Returns [#returns-7]

`boolean`

#### Implementation of [#implementation-of-5]

`ActivityBaseInternalInterface.isActive`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-3]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-8]

`void`

#### Inherited from [#inherited-from-2]

`StoredClassModel.migrateOldStorage`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-2]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-4]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-9]

`void`

#### Inherited from [#inherited-from-3]

`StoredClassModel.setStorageProperty`


# Class: CommitmentBaseModel (/nqtr/index/classes/CommitmentBaseModel)



Defined in: [src/classes/activity/CommitmentBaseModel.ts:22](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L22)

The base model of a commitment. I suggest you extend this class to create your own commitment model.
You must use the saveCommitment function to save the commitment in the registered commitments.

## Example [#example]

```ts
export const miaPlay = new CommitmentBaseModel("mia_play", mia, {
    name: "Test",
    image: "https://image.jpg",
    executionType: ExecutionTypeEnum.INTERACTION,
    onRun: (commitment) => {
        // Do something
    }
})
saveCommitment(miaPlay)
```

## Extends [#extends]

* [`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CommitmentBaseModel**(`id`, `character`, `props`): `CommitmentBaseModel`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:28](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L28)

#### Parameters [#parameters]

##### id [#id]

`string`

The id of the commitment, it must be unique.

##### character [#character]

`string` | `CharacterInterface` | (`string` | `CharacterInterface`)\[] | `undefined`

The character or characters that are in the commitment and so in the room.

##### props [#props]

[`CommitmentProps`](/nqtr/index/interfaces/CommitmentProps)

The properties of the commitment.

#### Returns [#returns]

`CommitmentBaseModel`

#### Overrides [#overrides]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`constructor`](/nqtr/index/classes/CommitmentStoredClass#constructor)

## Properties [#properties]

### \_onRun [#_onrun]

\> `protected` `readonly` **\_onRun**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)>

Defined in: [src/classes/activity/ActivityStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L19)

#### Inherited from [#inherited-from]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`_onRun`](/nqtr/index/classes/CommitmentStoredClass#_onrun)

***

### characters [#characters]

\> `readonly` **characters**: `CharacterInterface`\[]

Defined in: [src/classes/activity/CommitmentStoredClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L72)

The character or characters that are in the commitment and so in the room.

#### Inherited from [#inherited-from-1]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`characters`](/nqtr/index/classes/CommitmentStoredClass#characters)

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Inherited from [#inherited-from-2]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`id`](/nqtr/index/classes/CommitmentStoredClass#id)

***

### runOptions? [#runoptions]

\> `optional` **runOptions?**: `CommitmentRunOptions`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:111](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L111)

Options for [run](/nqtr/index/classes/CommitmentStoredClass#run).

#### Inherited from [#inherited-from-3]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`runOptions`](/nqtr/index/classes/CommitmentStoredClass#runoptions)

## Accessors [#accessors]

### dateScheduling [#datescheduling]

#### Get Signature [#get-signature]

\> **get** **dateScheduling**(): [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L34)

Used to schedule what date it will be added and removed.

##### Returns [#returns-1]

[`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

#### Inherited from [#inherited-from-4]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`dateScheduling`](/nqtr/index/classes/CommitmentStoredClass#datescheduling)

***

### disabled [#disabled]

#### Get Signature [#get-signature-1]

\> **get** **disabled**(): `boolean`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L82)

Whether is disabled. You can also pass a Pixi'VN flag name.

##### Returns [#returns-2]

`boolean`

#### Set Signature [#set-signature]

\> **set** **disabled**(`value`): `void`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:89](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L89)

##### Parameters [#parameters-1]

###### value [#value]

`string` | `boolean`

##### Returns [#returns-3]

`void`

***

### executionType [#executiontype]

#### Get Signature [#get-signature-2]

\> **get** **executionType**(): [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/classes/activity/CommitmentStoredClass.ts:74](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L74)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

##### Returns [#returns-4]

[`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

#### Set Signature [#set-signature-1]

\> **set** **executionType**(`value`): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:77](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L77)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

##### Parameters [#parameters-2]

###### value [#value-1]

[`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

##### Returns [#returns-5]

`void`

#### Inherited from [#inherited-from-5]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`executionType`](/nqtr/index/classes/CommitmentStoredClass#executiontype)

***

### expired [#expired]

#### Get Signature [#get-signature-3]

\> **get** **expired**(): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L48)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

##### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-6]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`expired`](/nqtr/index/classes/CommitmentStoredClass#expired)

***

### hidden [#hidden]

#### Get Signature [#get-signature-4]

\> **get** **hidden**(): `boolean`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:97](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L97)

Whether is hidden. You can also pass a Pixi'VN flag name.

##### Returns [#returns-7]

`boolean`

#### Set Signature [#set-signature-2]

\> **set** **hidden**(`value`): `void`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:104](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L104)

##### Parameters [#parameters-3]

###### value [#value-2]

`string` | `boolean`

##### Returns [#returns-8]

`void`

***

### icon [#icon]

#### Get Signature [#get-signature-5]

\> **get** **icon**(): `string` | `undefined`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:74](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L74)

The icon of the commitment.

##### Returns [#returns-9]

`string` | `undefined`

***

### image [#image]

#### Get Signature [#get-signature-6]

\> **get** **image**(): `string` | `undefined`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:66](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L66)

The image of the commitment.

##### Returns [#returns-10]

`string` | `undefined`

***

### name [#name]

#### Get Signature [#get-signature-7]

\> **get** **name**(): `string`

Defined in: [src/classes/activity/CommitmentBaseModel.ts:58](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentBaseModel.ts#L58)

The name of the commitment.

##### Returns [#returns-11]

`string`

***

### priority [#priority]

#### Get Signature [#get-signature-8]

\> **get** **priority**(): `number`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:81](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L81)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **priority**(`value`): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:84](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L84)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

##### Parameters [#parameters-4]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-7]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`priority`](/nqtr/index/classes/CommitmentStoredClass#priority)

***

### run [#run]

#### Get Signature [#get-signature-9]

\> **get** **run**(): (`props`, `options?`) => `Promise`\<`any`>

Defined in: [src/classes/activity/CommitmentStoredClass.ts:120](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L120)

Executes the commitment's `onRun` callback.

##### Returns [#returns-14]

(`props`, `options?`) => `Promise`\<`any`>

#### Inherited from [#inherited-from-8]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`run`](/nqtr/index/classes/CommitmentStoredClass#run)

***

### timeSlot [#timeslot]

#### Get Signature [#get-signature-10]

\> **get** **timeSlot**(): [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L29)

Time slot in which activity/commitment will be active.

##### Returns [#returns-15]

[`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

#### Inherited from [#inherited-from-9]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`timeSlot`](/nqtr/index/classes/CommitmentStoredClass#timeslot)

## Methods [#methods]

### addTempHistoryItem() [#addtemphistoryitem]

\> `protected` **addTempHistoryItem**(): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:87](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L87)

#### Returns [#returns-16]

`void`

#### Inherited from [#inherited-from-10]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`addTempHistoryItem`](/nqtr/index/classes/CommitmentStoredClass#addtemphistoryitem)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-5]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-17]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-11]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`getStorageProperty`](/nqtr/index/classes/CommitmentStoredClass#getstorageproperty)

***

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L55)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters-6]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

The options to check if the activity/commitment is active.

#### Returns [#returns-18]

`boolean`

#### Inherited from [#inherited-from-12]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`isActive`](/nqtr/index/classes/CommitmentStoredClass#isactive)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-7]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-19]

`void`

#### Inherited from [#inherited-from-13]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`migrateOldStorage`](/nqtr/index/classes/CommitmentStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-8]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-4]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-14]

[`CommitmentStoredClass`](/nqtr/index/classes/CommitmentStoredClass).[`setStorageProperty`](/nqtr/index/classes/CommitmentStoredClass#setstorageproperty)


# Class: CommitmentStoredClass (/nqtr/index/classes/CommitmentStoredClass)



Defined in: [src/classes/activity/CommitmentStoredClass.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L41)

## Extends [#extends]

* [`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)>

## Extended by [#extended-by]

* [`CommitmentBaseModel`](/nqtr/index/classes/CommitmentBaseModel)

## Implements [#implements]

* `CommitmentBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CommitmentStoredClass**(`id`, `characters`, `onRun`, `props`): `CommitmentStoredClass`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:45](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L45)

#### Parameters [#parameters]

##### id [#id]

`string`

##### characters [#characters]

(`string` | `CharacterInterface`)\[]

##### onRun [#onrun]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)> | `undefined`

##### props [#props]

[`CommitmentStoredClassProps`](/nqtr/index/interfaces/CommitmentStoredClassProps)

#### Returns [#returns]

`CommitmentStoredClass`

#### Overrides [#overrides]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`constructor`](/nqtr/index/classes/ActivityStoredClass#constructor)

## Properties [#properties]

### \_onRun [#_onrun]

\> `protected` `readonly` **\_onRun**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)>

Defined in: [src/classes/activity/ActivityStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L19)

#### Inherited from [#inherited-from]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`_onRun`](/nqtr/index/classes/ActivityStoredClass#_onrun)

***

### characters [#characters-1]

\> `readonly` **characters**: `CharacterInterface`\[]

Defined in: [src/classes/activity/CommitmentStoredClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L72)

The character or characters that are in the commitment and so in the room.

#### Implementation of [#implementation-of]

`CommitmentBaseInternalInterface.characters`

***

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of-1]

`CommitmentBaseInternalInterface.id`

#### Inherited from [#inherited-from-1]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`id`](/nqtr/index/classes/ActivityStoredClass#id)

***

### runOptions? [#runoptions]

\> `optional` **runOptions?**: `CommitmentRunOptions`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:111](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L111)

Options for [run](#run).

## Accessors [#accessors]

### dateScheduling [#datescheduling]

#### Get Signature [#get-signature]

\> **get** **dateScheduling**(): [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L34)

Used to schedule what date it will be added and removed.

##### Returns [#returns-1]

[`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface) | `undefined`

#### Implementation of [#implementation-of-2]

`CommitmentBaseInternalInterface.dateScheduling`

#### Inherited from [#inherited-from-2]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`dateScheduling`](/nqtr/index/classes/ActivityStoredClass#datescheduling)

***

### executionType [#executiontype]

#### Get Signature [#get-signature-1]

\> **get** **executionType**(): [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/classes/activity/CommitmentStoredClass.ts:74](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L74)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

##### Returns [#returns-2]

[`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

#### Set Signature [#set-signature]

\> **set** **executionType**(`value`): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:77](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L77)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

##### Parameters [#parameters-1]

###### value [#value]

[`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

##### Returns [#returns-3]

`void`

#### Implementation of [#implementation-of-3]

`CommitmentBaseInternalInterface.executionType`

***

### expired [#expired]

#### Get Signature [#get-signature-2]

\> **get** **expired**(): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L48)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

##### Returns [#returns-4]

`boolean`

#### Implementation of [#implementation-of-4]

`CommitmentBaseInternalInterface.expired`

#### Inherited from [#inherited-from-3]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`expired`](/nqtr/index/classes/ActivityStoredClass#expired)

***

### priority [#priority]

#### Get Signature [#get-signature-3]

\> **get** **priority**(): `number`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:81](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L81)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

##### Returns [#returns-5]

`number`

#### Set Signature [#set-signature-1]

\> **set** **priority**(`value`): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:84](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L84)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

##### Parameters [#parameters-2]

###### value [#value-1]

`number`

##### Returns [#returns-6]

`void`

#### Implementation of [#implementation-of-5]

`CommitmentBaseInternalInterface.priority`

***

### run [#run]

#### Get Signature [#get-signature-4]

\> **get** **run**(): (`props`, `options?`) => `Promise`\<`any`>

Defined in: [src/classes/activity/CommitmentStoredClass.ts:120](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L120)

Executes the commitment's `onRun` callback.

##### Returns [#returns-7]

(`props`, `options?`) => `Promise`\<`any`>

#### Implementation of [#implementation-of-6]

`CommitmentBaseInternalInterface.run`

#### Overrides [#overrides-1]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`run`](/nqtr/index/classes/ActivityStoredClass#run)

***

### timeSlot [#timeslot]

#### Get Signature [#get-signature-5]

\> **get** **timeSlot**(): [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

Defined in: [src/classes/activity/ActivityStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L29)

Time slot in which activity/commitment will be active.

##### Returns [#returns-8]

[`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[] | `undefined`

#### Implementation of [#implementation-of-7]

`CommitmentBaseInternalInterface.timeSlot`

#### Inherited from [#inherited-from-4]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`timeSlot`](/nqtr/index/classes/ActivityStoredClass#timeslot)

## Methods [#methods]

### addTempHistoryItem() [#addtemphistoryitem]

\> `protected` **addTempHistoryItem**(): `void`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:87](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L87)

#### Returns [#returns-9]

`void`

#### Overrides [#overrides-2]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`addTempHistoryItem`](/nqtr/index/classes/ActivityStoredClass#addtemphistoryitem)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-10]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-5]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`getStorageProperty`](/nqtr/index/classes/ActivityStoredClass#getstorageproperty)

***

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/classes/activity/ActivityStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L55)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters-4]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

The options to check if the activity/commitment is active.

#### Returns [#returns-11]

`boolean`

#### Implementation of [#implementation-of-8]

`CommitmentBaseInternalInterface.isActive`

#### Inherited from [#inherited-from-6]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`isActive`](/nqtr/index/classes/ActivityStoredClass#isactive)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-5]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-7]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`migrateOldStorage`](/nqtr/index/classes/ActivityStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-6]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-2]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-8]

[`ActivityStoredClass`](/nqtr/index/classes/ActivityStoredClass).[`setStorageProperty`](/nqtr/index/classes/ActivityStoredClass#setstorageproperty)


# Class: LocationBaseModel (/nqtr/index/classes/LocationBaseModel)



Defined in: [src/classes/navigation/LocationBaseModel.ts:16](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L16)

The base model of a location. I suggest you extend this class to create your own location model.

## Example [#example]

```typescript
export const mcHome = new LocationBaseModel('mc_home', mainMap, {
    name: 'MC Home',
    icon: "https://icon.jpg",
});
```

## Extends [#extends]

* [`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass)

## Implements [#implements]

* `LocationInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new LocationBaseModel**(`id`, `map`, `props?`): `LocationBaseModel`

Defined in: [src/classes/navigation/LocationBaseModel.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L25)

#### Parameters [#parameters]

##### id [#id]

`string`

The id of the location, it must be unique.

##### map [#map]

[`MapInterface`](/nqtr/index/interfaces/MapInterface)

The map where the location is.

##### props? [#props]

[`LocationBaseModelProps`](/nqtr/index/interfaces/LocationBaseModelProps) = `{}`

The properties of the location.

#### Returns [#returns]

`LocationBaseModel`

#### Overrides [#overrides]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`constructor`](/nqtr/index/classes/LocationStoredClass#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`LocationInternalInterface.id`

#### Inherited from [#inherited-from]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`id`](/nqtr/index/classes/LocationStoredClass#id)

## Accessors [#accessors]

### activities [#activities]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`LocationInternalInterface.activities`

#### Inherited from [#inherited-from-1]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`activities`](/nqtr/index/classes/LocationStoredClass#activities)

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`LocationInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`activitiesIds`](/nqtr/index/classes/LocationStoredClass#activitiesids)

***

### disabled [#disabled]

#### Get Signature [#get-signature-2]

\> **get** **disabled**(): `boolean`

Defined in: [src/classes/navigation/LocationBaseModel.ts:49](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L49)

Whether is disabled. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-3]

`boolean`

#### Set Signature [#set-signature]

\> **set** **disabled**(`value`): `void`

Defined in: [src/classes/navigation/LocationBaseModel.ts:56](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L56)

##### Parameters [#parameters-1]

###### value [#value]

`string` | `boolean`

##### Returns [#returns-4]

`void`

***

### hidden [#hidden]

#### Get Signature [#get-signature-3]

\> **get** **hidden**(): `boolean`

Defined in: [src/classes/navigation/LocationBaseModel.ts:64](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L64)

Whether is hidden. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-5]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **hidden**(`value`): `void`

Defined in: [src/classes/navigation/LocationBaseModel.ts:71](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L71)

##### Parameters [#parameters-2]

###### value [#value-1]

`string` | `boolean`

##### Returns [#returns-6]

`void`

***

### icon [#icon]

#### Get Signature [#get-signature-4]

\> **get** **icon**(): `string` | `undefined`

Defined in: [src/classes/navigation/LocationBaseModel.ts:79](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L79)

The icon of the location.

##### Returns [#returns-7]

`string` | `undefined`

***

### map [#map-1]

#### Get Signature [#get-signature-5]

\> **get** **map**(): [`MapInterface`](/nqtr/index/interfaces/MapInterface)

Defined in: [src/classes/navigation/LocationStoredClass.ts:22](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L22)

The map where the location is.

##### Returns [#returns-8]

[`MapInterface`](/nqtr/index/interfaces/MapInterface)

#### Implementation of [#implementation-of-3]

`LocationInternalInterface.map`

#### Inherited from [#inherited-from-3]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`map`](/nqtr/index/classes/LocationStoredClass#map)

***

### name [#name]

#### Get Signature [#get-signature-6]

\> **get** **name**(): `string`

Defined in: [src/classes/navigation/LocationBaseModel.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L38)

The name of the location.
If you set undefined, it will return the initial value of name.

##### Returns [#returns-9]

`string`

#### Set Signature [#set-signature-2]

\> **set** **name**(`value`): `void`

Defined in: [src/classes/navigation/LocationBaseModel.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationBaseModel.ts#L41)

##### Parameters [#parameters-3]

###### value [#value-2]

`string` | `undefined`

##### Returns [#returns-10]

`void`

***

### rooms [#rooms]

#### Get Signature [#get-signature-7]

\> **get** **rooms**(): [`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

Defined in: [src/classes/navigation/LocationStoredClass.ts:26](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L26)

Get all rooms in the location.

##### Returns [#returns-11]

[`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

The rooms in the location.

#### Implementation of [#implementation-of-4]

`LocationInternalInterface.rooms`

#### Inherited from [#inherited-from-4]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`rooms`](/nqtr/index/classes/LocationStoredClass#rooms)

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-4]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-12]

`void`

#### Implementation of [#implementation-of-5]

`LocationInternalInterface.addActivity`

#### Inherited from [#inherited-from-5]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`addActivity`](/nqtr/index/classes/LocationStoredClass#addactivity)

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-13]

`void`

#### Implementation of [#implementation-of-6]

`LocationInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-6]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`clearExpiredActivities`](/nqtr/index/classes/LocationStoredClass#clearexpiredactivities)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-5]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-14]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-7]

`LocationInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-7]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`getStorageProperty`](/nqtr/index/classes/LocationStoredClass#getstorageproperty)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-6]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-15]

`void`

#### Implementation of [#implementation-of-8]

`LocationInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-8]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`migrateOldStorage`](/nqtr/index/classes/LocationStoredClass#migrateoldstorage)

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-7]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-16]

`void`

#### Implementation of [#implementation-of-9]

`LocationInternalInterface.removeActivity`

#### Inherited from [#inherited-from-9]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`removeActivity`](/nqtr/index/classes/LocationStoredClass#removeactivity)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-8]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-3]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-17]

`void`

#### Implementation of [#implementation-of-10]

`LocationInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-10]

[`LocationStoredClass`](/nqtr/index/classes/LocationStoredClass).[`setStorageProperty`](/nqtr/index/classes/LocationStoredClass#setstorageproperty)


# Class: LocationStoredClass (/nqtr/index/classes/LocationStoredClass)



Defined in: [src/classes/navigation/LocationStoredClass.ts:7](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L7)

## Extends [#extends]

* `default`

## Extended by [#extended-by]

* [`LocationBaseModel`](/nqtr/index/classes/LocationBaseModel)

## Implements [#implements]

* `LocationInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new LocationStoredClass**(`id`, `_map`, `activities?`): `LocationStoredClass`

Defined in: [src/classes/navigation/LocationStoredClass.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L11)

#### Parameters [#parameters]

##### id [#id]

`string`

##### \_map [#_map]

[`MapInterface`](/nqtr/index/interfaces/MapInterface)

The map where the location is.

##### activities? [#activities]

(`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[] = `[]`

#### Returns [#returns]

`LocationStoredClass`

#### Overrides [#overrides]

`NavigationAbstractClass.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`LocationInternalInterface.id`

#### Inherited from [#inherited-from]

`NavigationAbstractClass.id`

## Accessors [#accessors]

### activities [#activities-1]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`LocationInternalInterface.activities`

#### Inherited from [#inherited-from-1]

`NavigationAbstractClass.activities`

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`LocationInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

`NavigationAbstractClass.activitiesIds`

***

### map [#map]

#### Get Signature [#get-signature-2]

\> **get** **map**(): [`MapInterface`](/nqtr/index/interfaces/MapInterface)

Defined in: [src/classes/navigation/LocationStoredClass.ts:22](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L22)

The map where the location is.

##### Returns [#returns-3]

[`MapInterface`](/nqtr/index/interfaces/MapInterface)

#### Implementation of [#implementation-of-3]

`LocationInternalInterface.map`

***

### rooms [#rooms]

#### Get Signature [#get-signature-3]

\> **get** **rooms**(): [`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

Defined in: [src/classes/navigation/LocationStoredClass.ts:26](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/LocationStoredClass.ts#L26)

Get all rooms in the location.

##### Returns [#returns-4]

[`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

The rooms in the location.

#### Implementation of [#implementation-of-4]

`LocationInternalInterface.rooms`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-1]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-5]

`void`

#### Implementation of [#implementation-of-5]

`LocationInternalInterface.addActivity`

#### Inherited from [#inherited-from-3]

`NavigationAbstractClass.addActivity`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-6]

`void`

#### Implementation of [#implementation-of-6]

`LocationInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-4]

`NavigationAbstractClass.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-2]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-7]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-7]

`LocationInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-5]

`NavigationAbstractClass.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-3]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-8]

`LocationInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-6]

`NavigationAbstractClass.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-4]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-9]

`void`

#### Implementation of [#implementation-of-9]

`LocationInternalInterface.removeActivity`

#### Inherited from [#inherited-from-7]

`NavigationAbstractClass.removeActivity`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-5]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-10]

`void`

#### Implementation of [#implementation-of-10]

`LocationInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-8]

`NavigationAbstractClass.setStorageProperty`


# Class: MapBaseModel (/nqtr/index/classes/MapBaseModel)



Defined in: [src/classes/navigation/MapBaseModel.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L15)

The base model of a map. I suggest you extend this class to create your own map model.

## Example [#example]

```typescript
export const mainMap = new MapBaseModel('main_map', {
    name: 'Main Map',
    image: "https://image.jpg",
});
```

## Extends [#extends]

* [`MapStoredClass`](/nqtr/index/classes/MapStoredClass)

## Implements [#implements]

* `MapBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new MapBaseModel**(`id`, `props?`): `MapBaseModel`

Defined in: [src/classes/navigation/MapBaseModel.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L20)

#### Parameters [#parameters]

##### id [#id]

`string`

The id of the map, it must be unique.

##### props? [#props]

[`MapBaseModelProps`](/nqtr/index/interfaces/MapBaseModelProps) = `{}`

The properties of the map.

#### Returns [#returns]

`MapBaseModel`

#### Overrides [#overrides]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`constructor`](/nqtr/index/classes/MapStoredClass#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`MapBaseInternalInterface.id`

#### Inherited from [#inherited-from]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`id`](/nqtr/index/classes/MapStoredClass#id)

## Accessors [#accessors]

### activities [#activities]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`MapBaseInternalInterface.activities`

#### Inherited from [#inherited-from-1]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`activities`](/nqtr/index/classes/MapStoredClass#activities)

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`MapBaseInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`activitiesIds`](/nqtr/index/classes/MapStoredClass#activitiesids)

***

### image [#image]

#### Get Signature [#get-signature-2]

\> **get** **image**(): `string` | `undefined`

Defined in: [src/classes/navigation/MapBaseModel.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L42)

The image of the map.

##### Returns [#returns-3]

`string` | `undefined`

***

### locations [#locations]

#### Get Signature [#get-signature-3]

\> **get** **locations**(): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

Defined in: [src/classes/navigation/MapStoredClass.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapStoredClass.ts#L15)

Get all locations in the map.

##### Returns [#returns-4]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

The locations in the map.

#### Implementation of [#implementation-of-3]

`MapBaseInternalInterface.locations`

#### Inherited from [#inherited-from-3]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`locations`](/nqtr/index/classes/MapStoredClass#locations)

***

### name [#name]

#### Get Signature [#get-signature-4]

\> **get** **name**(): `string`

Defined in: [src/classes/navigation/MapBaseModel.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L31)

The name of the map.
If you set undefined, it will return the initial value of name.

##### Returns [#returns-5]

`string`

#### Set Signature [#set-signature]

\> **set** **name**(`value`): `void`

Defined in: [src/classes/navigation/MapBaseModel.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapBaseModel.ts#L34)

##### Parameters [#parameters-1]

###### value [#value]

`string` | `undefined`

##### Returns [#returns-6]

`void`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-2]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-4]

`MapBaseInternalInterface.addActivity`

#### Inherited from [#inherited-from-4]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`addActivity`](/nqtr/index/classes/MapStoredClass#addactivity)

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-5]

`MapBaseInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-5]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`clearExpiredActivities`](/nqtr/index/classes/MapStoredClass#clearexpiredactivities)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-9]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-6]

`MapBaseInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-6]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`getStorageProperty`](/nqtr/index/classes/MapStoredClass#getstorageproperty)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-4]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-10]

`void`

#### Implementation of [#implementation-of-7]

`MapBaseInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-7]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`migrateOldStorage`](/nqtr/index/classes/MapStoredClass#migrateoldstorage)

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-5]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-11]

`void`

#### Implementation of [#implementation-of-8]

`MapBaseInternalInterface.removeActivity`

#### Inherited from [#inherited-from-8]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`removeActivity`](/nqtr/index/classes/MapStoredClass#removeactivity)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-6]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-1]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-12]

`void`

#### Implementation of [#implementation-of-9]

`MapBaseInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-9]

[`MapStoredClass`](/nqtr/index/classes/MapStoredClass).[`setStorageProperty`](/nqtr/index/classes/MapStoredClass#setstorageproperty)


# Class: MapStoredClass (/nqtr/index/classes/MapStoredClass)



Defined in: [src/classes/navigation/MapStoredClass.ts:7](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapStoredClass.ts#L7)

## Extends [#extends]

* `default`

## Extended by [#extended-by]

* [`MapBaseModel`](/nqtr/index/classes/MapBaseModel)

## Implements [#implements]

* `MapBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new MapStoredClass**(`id`, `activities?`): `MapStoredClass`

Defined in: [src/classes/navigation/MapStoredClass.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapStoredClass.ts#L11)

#### Parameters [#parameters]

##### id [#id]

`string`

##### activities? [#activities]

(`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[] = `[]`

#### Returns [#returns]

`MapStoredClass`

#### Overrides [#overrides]

`NavigationAbstractClass.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`MapBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`NavigationAbstractClass.id`

## Accessors [#accessors]

### activities [#activities-1]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`MapBaseInternalInterface.activities`

#### Inherited from [#inherited-from-1]

`NavigationAbstractClass.activities`

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`MapBaseInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

`NavigationAbstractClass.activitiesIds`

***

### locations [#locations]

#### Get Signature [#get-signature-2]

\> **get** **locations**(): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

Defined in: [src/classes/navigation/MapStoredClass.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/MapStoredClass.ts#L15)

Get all locations in the map.

##### Returns [#returns-3]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

The locations in the map.

#### Implementation of [#implementation-of-3]

`MapBaseInternalInterface.locations`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-1]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-4]

`void`

#### Implementation of [#implementation-of-4]

`MapBaseInternalInterface.addActivity`

#### Inherited from [#inherited-from-3]

`NavigationAbstractClass.addActivity`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-5]

`void`

#### Implementation of [#implementation-of-5]

`MapBaseInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-4]

`NavigationAbstractClass.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-2]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-6]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-6]

`MapBaseInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-5]

`NavigationAbstractClass.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-3]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-7]

`MapBaseInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-6]

`NavigationAbstractClass.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-4]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-8]

`MapBaseInternalInterface.removeActivity`

#### Inherited from [#inherited-from-7]

`NavigationAbstractClass.removeActivity`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-5]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-9]

`void`

#### Implementation of [#implementation-of-9]

`MapBaseInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-8]

`NavigationAbstractClass.setStorageProperty`


# Class: QuestBaseModel (/nqtr/index/classes/QuestBaseModel)



Defined in: [src/classes/quest/QuestBaseModel.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L4)

## Extends [#extends]

* [`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new QuestBaseModel**(`id`, `stages`, `props`): `QuestBaseModel`

Defined in: [src/classes/quest/QuestBaseModel.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L5)

#### Parameters [#parameters]

##### id [#id]

`string`

##### stages [#stages]

[`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

##### props [#props]

[`QuestProps`](/nqtr/index/interfaces/QuestProps)

#### Returns [#returns]

`QuestBaseModel`

#### Overrides [#overrides]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`constructor`](/nqtr/index/classes/QuestStoredClass#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Inherited from [#inherited-from]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`id`](/nqtr/index/classes/QuestStoredClass#id)

## Accessors [#accessors]

### completed [#completed]

#### Get Signature [#get-signature]

\> **get** **completed**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L62)

If the quest is completed.

##### Returns [#returns-1]

`boolean`

#### Inherited from [#inherited-from-1]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`completed`](/nqtr/index/classes/QuestStoredClass#completed)

***

### currentStage [#currentstage]

#### Get Signature [#get-signature-1]

\> **get** **currentStage**(): [`StageInterface`](/nqtr/index/interfaces/StageInterface) | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L50)

The current stage.

##### Returns [#returns-2]

[`StageInterface`](/nqtr/index/interfaces/StageInterface) | `undefined`

#### Inherited from [#inherited-from-2]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`currentStage`](/nqtr/index/classes/QuestStoredClass#currentstage)

***

### currentStageIndex [#currentstageindex]

#### Get Signature [#get-signature-2]

\> **get** **currentStageIndex**(): `number` | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L43)

The index of the current stage.

##### Returns [#returns-3]

`number` | `undefined`

#### Set Signature [#set-signature]

\> **set** **currentStageIndex**(`value`): `void`

Defined in: [src/classes/quest/QuestStoredClass.ts:46](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L46)

The index of the current stage.

##### Parameters [#parameters-1]

###### value [#value]

`number` | `undefined`

##### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-3]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`currentStageIndex`](/nqtr/index/classes/QuestStoredClass#currentstageindex)

***

### currentStageMustStart [#currentstagemuststart]

#### Get Signature [#get-signature-3]

\> **get** **currentStageMustStart**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:188](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L188)

If the current stage must start. It is true if the current stage is not started, can start and not completed.

##### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-4]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`currentStageMustStart`](/nqtr/index/classes/QuestStoredClass#currentstagemuststart)

***

### description [#description]

#### Get Signature [#get-signature-4]

\> **get** **description**(): `string`

Defined in: [src/classes/quest/QuestBaseModel.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L29)

The description of the quest.

##### Returns [#returns-6]

`string`

***

### failed [#failed]

#### Get Signature [#get-signature-5]

\> **get** **failed**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:79](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L79)

If the quest is failed.

##### Returns [#returns-7]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **failed**(`value`): `void`

Defined in: [src/classes/quest/QuestStoredClass.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L82)

If the quest is failed.

##### Parameters [#parameters-2]

###### value [#value-1]

`boolean`

##### Returns [#returns-8]

`void`

#### Inherited from [#inherited-from-5]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`failed`](/nqtr/index/classes/QuestStoredClass#failed)

***

### icon [#icon]

#### Get Signature [#get-signature-6]

\> **get** **icon**(): `string` | `undefined`

Defined in: [src/classes/quest/QuestBaseModel.ts:37](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L37)

Icon of the quest.

##### Returns [#returns-9]

`string` | `undefined`

***

### image [#image]

#### Get Signature [#get-signature-7]

\> **get** **image**(): `string` | `undefined`

Defined in: [src/classes/quest/QuestBaseModel.ts:45](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L45)

Image of the quest.

##### Returns [#returns-10]

`string` | `undefined`

***

### inDevelopment [#indevelopment]

#### Get Signature [#get-signature-8]

\> **get** **inDevelopment**(): `boolean`

Defined in: [src/classes/quest/QuestBaseModel.ts:53](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L53)

If the quest is in development.

##### Returns [#returns-11]

`boolean`

***

### inProgress [#inprogress]

#### Get Signature [#get-signature-9]

\> **get** **inProgress**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L69)

If the quest is started and not completed and not failed.

##### Returns [#returns-12]

`boolean`

#### Inherited from [#inherited-from-6]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`inProgress`](/nqtr/index/classes/QuestStoredClass#inprogress)

***

### name [#name]

#### Get Signature [#get-signature-10]

\> **get** **name**(): `string`

Defined in: [src/classes/quest/QuestBaseModel.ts:21](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestBaseModel.ts#L21)

The name of the quest.

##### Returns [#returns-13]

`string`

***

### onContinue [#oncontinue]

#### Get Signature [#get-signature-11]

\> **get** **onContinue**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:92](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L92)

The function that will be called when the quest goes to the next stage.

##### Returns [#returns-14]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Inherited from [#inherited-from-7]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`onContinue`](/nqtr/index/classes/QuestStoredClass#oncontinue)

***

### onNextStage [#onnextstage]

#### Get Signature [#get-signature-12]

\> **get** **onNextStage**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:95](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L95)

##### Deprecated [#deprecated]

Use [onContinue](/nqtr/index/interfaces/QuestInterface#oncontinue) instead. The function that will be called when the quest goes to the next stage.

##### Returns [#returns-15]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Inherited from [#inherited-from-8]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`onNextStage`](/nqtr/index/classes/QuestStoredClass#onnextstage)

***

### onStart [#onstart]

#### Get Signature [#get-signature-13]

\> **get** **onStart**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:87](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L87)

The function that will be called when the quest starts.

##### Returns [#returns-16]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Inherited from [#inherited-from-9]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`onStart`](/nqtr/index/classes/QuestStoredClass#onstart)

***

### stages [#stages-1]

#### Get Signature [#get-signature-14]

\> **get** **stages**(): [`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

Defined in: [src/classes/quest/QuestStoredClass.ts:39](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L39)

The stages of the quest.

##### Returns [#returns-17]

[`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

#### Inherited from [#inherited-from-10]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`stages`](/nqtr/index/classes/QuestStoredClass#stages)

***

### started [#started]

#### Get Signature [#get-signature-15]

\> **get** **started**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:58](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L58)

If the quest is started.

##### Returns [#returns-18]

`boolean`

#### Inherited from [#inherited-from-11]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`started`](/nqtr/index/classes/QuestStoredClass#started)

## Methods [#methods]

### advanceIfCompleted() [#advanceifcompleted]

\> **advanceIfCompleted**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:124](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L124)

Go to the next stage if the current stage is completed.
If you want to force the change of stage, use [advanceUnconditionally](/nqtr/index/interfaces/QuestInterface#advanceunconditionally).

#### Parameters [#parameters-3]

##### props [#props-1]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-19]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-12]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`advanceIfCompleted`](/nqtr/index/classes/QuestStoredClass#advanceifcompleted)

***

### advanceUnconditionally() [#advanceunconditionally]

\> **advanceUnconditionally**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:161](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L161)

Ignore the completed state of the current stage and go to the next stage without checking if the current stage is completed.
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](/nqtr/index/interfaces/QuestInterface#advanceifcompleted).

#### Parameters [#parameters-4]

##### props [#props-2]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-20]

`Promise`\<`boolean`>

returns true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-13]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`advanceUnconditionally`](/nqtr/index/classes/QuestStoredClass#advanceunconditionally)

***

### continue() [#continue]

\> **continue**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:145](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L145)

Complete the current stage and go to the next stage with [advanceUnconditionally](/nqtr/index/interfaces/QuestInterface#advanceunconditionally).
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](/nqtr/index/interfaces/QuestInterface#advanceifcompleted).

#### Parameters [#parameters-5]

##### props [#props-3]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-21]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-14]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`continue`](/nqtr/index/classes/QuestStoredClass#continue)

***

### ~~forceGoNext()~~ [#forcegonext]

\> **forceGoNext**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:158](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L158)

#### Parameters [#parameters-6]

##### props [#props-4]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-22]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-1]

Use [advanceUnconditionally](/nqtr/index/classes/QuestStoredClass#advanceunconditionally) instead.

#### Inherited from [#inherited-from-15]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`forceGoNext`](/nqtr/index/classes/QuestStoredClass#forcegonext)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-7]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-23]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-16]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`getStorageProperty`](/nqtr/index/classes/QuestStoredClass#getstorageproperty)

***

### ~~goNext()~~ [#gonext]

\> **goNext**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:142](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L142)

#### Parameters [#parameters-8]

##### props [#props-5]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-24]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-2]

Use [continue](/nqtr/index/classes/QuestStoredClass#continue) instead.

#### Inherited from [#inherited-from-17]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`goNext`](/nqtr/index/classes/QuestStoredClass#gonext)

***

### ~~goNextIfCompleted()~~ [#gonextifcompleted]

\> **goNextIfCompleted**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:121](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L121)

#### Parameters [#parameters-9]

##### props [#props-6]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-25]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-3]

Use [advanceIfCompleted](/nqtr/index/classes/QuestStoredClass#advanceifcompleted) instead.

#### Inherited from [#inherited-from-18]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`goNextIfCompleted`](/nqtr/index/classes/QuestStoredClass#gonextifcompleted)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-10]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-19]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`migrateOldStorage`](/nqtr/index/classes/QuestStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-11]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-2]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-27]

`void`

#### Inherited from [#inherited-from-20]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`setStorageProperty`](/nqtr/index/classes/QuestStoredClass#setstorageproperty)

***

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/QuestStoredClass.ts:99](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L99)

Start the quest.

#### Parameters [#parameters-12]

##### props [#props-7]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-28]

`Promise`\<`void`>

#### Inherited from [#inherited-from-21]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`start`](/nqtr/index/classes/QuestStoredClass#start)

***

### startCurrentStage() [#startcurrentstage]

\> **startCurrentStage**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/QuestStoredClass.ts:196](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L196)

Start the current stage. This is a system function, do not use it directly.

#### Parameters [#parameters-13]

##### props [#props-8]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-29]

`Promise`\<`void`>

#### Inherited from [#inherited-from-22]

[`QuestStoredClass`](/nqtr/index/classes/QuestStoredClass).[`startCurrentStage`](/nqtr/index/classes/QuestStoredClass#startcurrentstage)


# Class: QuestStoredClass (/nqtr/index/classes/QuestStoredClass)



Defined in: [src/classes/quest/QuestStoredClass.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L25)

## Extends [#extends]

* `StoredClassModel`

## Extended by [#extended-by]

* [`QuestBaseModel`](/nqtr/index/classes/QuestBaseModel)

## Implements [#implements]

* `QuestBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new QuestStoredClass**(`id`, `_stages`, `props?`): `QuestStoredClass`

Defined in: [src/classes/quest/QuestStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L29)

#### Parameters [#parameters]

##### id [#id]

`string`

##### \_stages [#_stages]

[`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

##### props? [#props]

[`QuestStoredClassProps`](/nqtr/index/interfaces/QuestStoredClassProps) = `{}`

#### Returns [#returns]

`QuestStoredClass`

#### Overrides [#overrides]

`StoredClassModel.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`QuestBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`StoredClassModel.id`

## Accessors [#accessors]

### completed [#completed]

#### Get Signature [#get-signature]

\> **get** **completed**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L62)

If the quest is completed.

##### Returns [#returns-1]

`boolean`

#### Implementation of [#implementation-of-1]

`QuestBaseInternalInterface.completed`

***

### currentStage [#currentstage]

#### Get Signature [#get-signature-1]

\> **get** **currentStage**(): [`StageInterface`](/nqtr/index/interfaces/StageInterface) | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L50)

The current stage.

##### Returns [#returns-2]

[`StageInterface`](/nqtr/index/interfaces/StageInterface) | `undefined`

#### Implementation of [#implementation-of-2]

`QuestBaseInternalInterface.currentStage`

***

### currentStageIndex [#currentstageindex]

#### Get Signature [#get-signature-2]

\> **get** **currentStageIndex**(): `number` | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L43)

The index of the current stage.

##### Returns [#returns-3]

`number` | `undefined`

#### Set Signature [#set-signature]

\> **set** **currentStageIndex**(`value`): `void`

Defined in: [src/classes/quest/QuestStoredClass.ts:46](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L46)

The index of the current stage.

##### Parameters [#parameters-1]

###### value [#value]

`number` | `undefined`

##### Returns [#returns-4]

`void`

#### Implementation of [#implementation-of-3]

`QuestBaseInternalInterface.currentStageIndex`

***

### currentStageMustStart [#currentstagemuststart]

#### Get Signature [#get-signature-3]

\> **get** **currentStageMustStart**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:188](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L188)

If the current stage must start. It is true if the current stage is not started, can start and not completed.

##### Returns [#returns-5]

`boolean`

#### Implementation of [#implementation-of-4]

`QuestBaseInternalInterface.currentStageMustStart`

***

### failed [#failed]

#### Get Signature [#get-signature-4]

\> **get** **failed**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:79](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L79)

If the quest is failed.

##### Returns [#returns-6]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **failed**(`value`): `void`

Defined in: [src/classes/quest/QuestStoredClass.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L82)

If the quest is failed.

##### Parameters [#parameters-2]

###### value [#value-1]

`boolean`

##### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-5]

`QuestBaseInternalInterface.failed`

***

### inProgress [#inprogress]

#### Get Signature [#get-signature-5]

\> **get** **inProgress**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L69)

If the quest is started and not completed and not failed.

##### Returns [#returns-8]

`boolean`

#### Implementation of [#implementation-of-6]

`QuestBaseInternalInterface.inProgress`

***

### onContinue [#oncontinue]

#### Get Signature [#get-signature-6]

\> **get** **onContinue**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:92](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L92)

The function that will be called when the quest goes to the next stage.

##### Returns [#returns-9]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Implementation of [#implementation-of-7]

`QuestBaseInternalInterface.onContinue`

***

### onNextStage [#onnextstage]

#### Get Signature [#get-signature-7]

\> **get** **onNextStage**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:95](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L95)

##### Deprecated [#deprecated]

Use [onContinue](/nqtr/index/interfaces/QuestInterface#oncontinue) instead. The function that will be called when the quest goes to the next stage.

##### Returns [#returns-10]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Implementation of [#implementation-of-8]

`QuestBaseInternalInterface.onNextStage`

***

### onStart [#onstart]

#### Get Signature [#get-signature-8]

\> **get** **onStart**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

Defined in: [src/classes/quest/QuestStoredClass.ts:87](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L87)

The function that will be called when the quest starts.

##### Returns [#returns-11]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)> | `undefined`

#### Implementation of [#implementation-of-9]

`QuestBaseInternalInterface.onStart`

***

### stages [#stages]

#### Get Signature [#get-signature-9]

\> **get** **stages**(): [`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

Defined in: [src/classes/quest/QuestStoredClass.ts:39](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L39)

The stages of the quest.

##### Returns [#returns-12]

[`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

#### Implementation of [#implementation-of-10]

`QuestBaseInternalInterface.stages`

***

### started [#started]

#### Get Signature [#get-signature-10]

\> **get** **started**(): `boolean`

Defined in: [src/classes/quest/QuestStoredClass.ts:58](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L58)

If the quest is started.

##### Returns [#returns-13]

`boolean`

#### Implementation of [#implementation-of-11]

`QuestBaseInternalInterface.started`

## Methods [#methods]

### advanceIfCompleted() [#advanceifcompleted]

\> **advanceIfCompleted**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:124](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L124)

Go to the next stage if the current stage is completed.
If you want to force the change of stage, use [advanceUnconditionally](/nqtr/index/interfaces/QuestInterface#advanceunconditionally).

#### Parameters [#parameters-3]

##### props [#props-1]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-14]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Implementation of [#implementation-of-12]

`QuestBaseInternalInterface.advanceIfCompleted`

***

### advanceUnconditionally() [#advanceunconditionally]

\> **advanceUnconditionally**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:161](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L161)

Ignore the completed state of the current stage and go to the next stage without checking if the current stage is completed.
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](/nqtr/index/interfaces/QuestInterface#advanceifcompleted).

#### Parameters [#parameters-4]

##### props [#props-2]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-15]

`Promise`\<`boolean`>

returns true if the stage was changed, false otherwise.

#### Implementation of [#implementation-of-13]

`QuestBaseInternalInterface.advanceUnconditionally`

***

### continue() [#continue]

\> **continue**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:145](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L145)

Complete the current stage and go to the next stage with [advanceUnconditionally](/nqtr/index/interfaces/QuestInterface#advanceunconditionally).
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](/nqtr/index/interfaces/QuestInterface#advanceifcompleted).

#### Parameters [#parameters-5]

##### props [#props-3]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-16]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Implementation of [#implementation-of-14]

`QuestBaseInternalInterface.continue`

***

### ~~forceGoNext()~~ [#forcegonext]

\> **forceGoNext**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:158](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L158)

#### Parameters [#parameters-6]

##### props [#props-4]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-17]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-1]

Use [advanceUnconditionally](#advanceunconditionally) instead.

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-7]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-18]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-1]

`StoredClassModel.getStorageProperty`

***

### ~~goNext()~~ [#gonext]

\> **goNext**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:142](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L142)

#### Parameters [#parameters-8]

##### props [#props-5]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-19]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-2]

Use [continue](#continue) instead.

***

### ~~goNextIfCompleted()~~ [#gonextifcompleted]

\> **goNextIfCompleted**(`props`): `Promise`\<`boolean`>

Defined in: [src/classes/quest/QuestStoredClass.ts:121](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L121)

#### Parameters [#parameters-9]

##### props [#props-6]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-20]

`Promise`\<`boolean`>

#### Deprecated [#deprecated-3]

Use [advanceIfCompleted](#advanceifcompleted) instead.

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-10]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-2]

`StoredClassModel.migrateOldStorage`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-11]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-2]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-22]

`void`

#### Inherited from [#inherited-from-3]

`StoredClassModel.setStorageProperty`

***

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/QuestStoredClass.ts:99](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L99)

Start the quest.

#### Parameters [#parameters-12]

##### props [#props-7]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-23]

`Promise`\<`void`>

#### Implementation of [#implementation-of-15]

`QuestBaseInternalInterface.start`

***

### startCurrentStage() [#startcurrentstage]

\> **startCurrentStage**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/QuestStoredClass.ts:196](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L196)

Start the current stage. This is a system function, do not use it directly.

#### Parameters [#parameters-13]

##### props [#props-8]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-24]

`Promise`\<`void`>

#### Implementation of [#implementation-of-16]

`QuestBaseInternalInterface.startCurrentStage`


# Class: RoomBaseModel (/nqtr/index/classes/RoomBaseModel)



Defined in: [src/classes/navigation/RoomBaseModel.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L19)

The base model of a room. I suggest you extend this class to create your own room model.
**You must use the [RegisteredRooms.add](/nqtr/index/namespaces/RegisteredRooms/functions/add) function to save the room in the registered rooms.**

## Example [#example]

```ts
export const mcRoom = new RoomBaseModel('mc_room', mcHome, {
    name: "MC Room",
    icon: "https://icon.jpg",
    image: "https://image.jpg",
})
RegisteredRooms.add(mcRoom)
```

## Extends [#extends]

* [`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new RoomBaseModel**(`id`, `location`, `props?`): `RoomBaseModel`

Defined in: [src/classes/navigation/RoomBaseModel.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L25)

#### Parameters [#parameters]

##### id [#id]

`string`

The id of the room, it must be unique.

##### location [#location]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

The location where the room is.

##### props? [#props]

[`RoomBaseModelProps`](/nqtr/index/interfaces/RoomBaseModelProps) = `{}`

The properties of the room.

#### Returns [#returns]

`RoomBaseModel`

#### Overrides [#overrides]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`constructor`](/nqtr/index/classes/RoomStoredClass#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Inherited from [#inherited-from]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`id`](/nqtr/index/classes/RoomStoredClass#id)

## Accessors [#accessors]

### activities [#activities]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Inherited from [#inherited-from-1]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`activities`](/nqtr/index/classes/RoomStoredClass#activities)

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Inherited from [#inherited-from-2]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`activitiesIds`](/nqtr/index/classes/RoomStoredClass#activitiesids)

***

### automaticFunctions [#automaticfunctions]

#### Get Signature [#get-signature-2]

\> **get** **automaticFunctions**(): [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:103](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L103)

Get the functions that will be executed when the room is visited.

##### Returns [#returns-3]

[`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

#### Inherited from [#inherited-from-3]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`automaticFunctions`](/nqtr/index/classes/RoomStoredClass#automaticfunctions)

***

### characters [#characters]

#### Get Signature [#get-signature-3]

\> **get** **characters**(): `CharacterInterface`\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:96](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L96)

Get the characters in the room.

##### Returns [#returns-4]

`CharacterInterface`\[]

#### Inherited from [#inherited-from-4]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`characters`](/nqtr/index/classes/RoomStoredClass#characters)

***

### disabled [#disabled]

#### Get Signature [#get-signature-4]

\> **get** **disabled**(): `boolean`

Defined in: [src/classes/navigation/RoomBaseModel.ts:61](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L61)

Whether is disabled. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-5]

`boolean`

#### Set Signature [#set-signature]

\> **set** **disabled**(`value`): `void`

Defined in: [src/classes/navigation/RoomBaseModel.ts:68](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L68)

##### Parameters [#parameters-1]

###### value [#value]

`string` | `boolean`

##### Returns [#returns-6]

`void`

***

### hidden [#hidden]

#### Get Signature [#get-signature-5]

\> **get** **hidden**(): `boolean`

Defined in: [src/classes/navigation/RoomBaseModel.ts:76](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L76)

Whether is hidden. If it is a string, it is a Pixi'VN flag name.

##### Returns [#returns-7]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **hidden**(`value`): `void`

Defined in: [src/classes/navigation/RoomBaseModel.ts:83](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L83)

##### Parameters [#parameters-2]

###### value [#value-1]

`string` | `boolean`

##### Returns [#returns-8]

`void`

***

### icon [#icon]

#### Get Signature [#get-signature-6]

\> **get** **icon**(): `string` | `undefined`

Defined in: [src/classes/navigation/RoomBaseModel.ts:91](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L91)

The function for rendering the icon of the room.

##### Returns [#returns-9]

`string` | `undefined`

***

### image [#image]

#### Get Signature [#get-signature-7]

\> **get** **image**(): `string` | `undefined`

Defined in: [src/classes/navigation/RoomBaseModel.ts:53](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L53)

The image of the room.

##### Returns [#returns-10]

`string` | `undefined`

***

### location [#location-1]

#### Get Signature [#get-signature-8]

\> **get** **location**(): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

Defined in: [src/classes/navigation/RoomStoredClass.ts:92](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L92)

The location where the room is.

##### Returns [#returns-11]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

#### Inherited from [#inherited-from-5]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`location`](/nqtr/index/classes/RoomStoredClass#location)

***

### name [#name]

#### Get Signature [#get-signature-9]

\> **get** **name**(): `string`

Defined in: [src/classes/navigation/RoomBaseModel.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L42)

The name.
If you set undefined, it will return the initial value of name.

##### Returns [#returns-12]

`string`

#### Set Signature [#set-signature-2]

\> **set** **name**(`value`): `void`

Defined in: [src/classes/navigation/RoomBaseModel.ts:45](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomBaseModel.ts#L45)

##### Parameters [#parameters-3]

###### value [#value-2]

`string` | `undefined`

##### Returns [#returns-13]

`void`

***

### routine [#routine]

#### Get Signature [#get-signature-10]

\> **get** **routine**(): [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L48)

Get the character commitments of the room.

##### Returns [#returns-14]

[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

#### Inherited from [#inherited-from-6]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`routine`](/nqtr/index/classes/RoomStoredClass#routine)

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-4]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-7]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`addActivity`](/nqtr/index/classes/RoomStoredClass#addactivity)

***

### addCommitment() [#addcommitment]

\> **addCommitment**(`commitment`, `options?`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L51)

Connects the commitment to the class.

#### Parameters [#parameters-5]

##### commitment [#commitment]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to connect to the class.

##### options? [#options-1]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-16]

`void`

#### Inherited from [#inherited-from-8]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`addCommitment`](/nqtr/index/classes/RoomStoredClass#addcommitment)

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-17]

`void`

#### Inherited from [#inherited-from-9]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`clearExpiredActivities`](/nqtr/index/classes/RoomStoredClass#clearexpiredactivities)

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-6]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-18]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-10]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`getStorageProperty`](/nqtr/index/classes/RoomStoredClass#getstorageproperty)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-7]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-19]

`void`

#### Inherited from [#inherited-from-11]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`migrateOldStorage`](/nqtr/index/classes/RoomStoredClass#migrateoldstorage)

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-8]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-12]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`removeActivity`](/nqtr/index/classes/RoomStoredClass#removeactivity)

***

### removeCommitment() [#removecommitment]

\> **removeCommitment**(`commitment`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:88](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L88)

Disconnects the commitment from the class.

#### Parameters [#parameters-9]

##### commitment [#commitment-1]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to disconnect from the class.

#### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-13]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`removeCommitment`](/nqtr/index/classes/RoomStoredClass#removecommitment)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-10]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-3]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-22]

`void`

#### Inherited from [#inherited-from-14]

[`RoomStoredClass`](/nqtr/index/classes/RoomStoredClass).[`setStorageProperty`](/nqtr/index/classes/RoomStoredClass#setstorageproperty)


# Class: RoomStoredClass (/nqtr/index/classes/RoomStoredClass)



Defined in: [src/classes/navigation/RoomStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L19)

## Extends [#extends]

* `default`

## Extended by [#extended-by]

* [`RoomBaseModel`](/nqtr/index/classes/RoomBaseModel)

## Implements [#implements]

* `RoomBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new RoomStoredClass**(`id`, `location`, `activities?`): `RoomStoredClass`

Defined in: [src/classes/navigation/RoomStoredClass.ts:24](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L24)

#### Parameters [#parameters]

##### id [#id]

`string`

##### location [#location]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

The location where the room is.

##### activities? [#activities]

(`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[] | \{ `activities`: (`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[]; `routine`: (`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface))\[]; }

#### Returns [#returns]

`RoomStoredClass`

#### Overrides [#overrides]

`NavigationAbstractClass.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`RoomBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`NavigationAbstractClass.id`

## Accessors [#accessors]

### activities [#activities-1]

#### Get Signature [#get-signature]

\> **get** **activities**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:176](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L176)

The activities associated with this class, filtered based on their scheduling.

##### Returns [#returns-1]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

#### Implementation of [#implementation-of-1]

`RoomBaseInternalInterface.activities`

#### Inherited from [#inherited-from-1]

`NavigationAbstractClass.activities`

***

### activitiesIds [#activitiesids]

#### Get Signature [#get-signature-1]

\> **get** **activitiesIds**(): `string`\[]

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L69)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

##### Returns [#returns-2]

`string`\[]

#### Implementation of [#implementation-of-2]

`RoomBaseInternalInterface.activitiesIds`

#### Inherited from [#inherited-from-2]

`NavigationAbstractClass.activitiesIds`

***

### automaticFunctions [#automaticfunctions]

#### Get Signature [#get-signature-2]

\> **get** **automaticFunctions**(): [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:103](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L103)

Get the functions that will be executed when the room is visited.

##### Returns [#returns-3]

[`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

#### Implementation of [#implementation-of-3]

`RoomBaseInternalInterface.automaticFunctions`

***

### characters [#characters]

#### Get Signature [#get-signature-3]

\> **get** **characters**(): `CharacterInterface`\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:96](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L96)

Get the characters in the room.

##### Returns [#returns-4]

`CharacterInterface`\[]

#### Implementation of [#implementation-of-4]

`RoomBaseInternalInterface.characters`

***

### location [#location-1]

#### Get Signature [#get-signature-4]

\> **get** **location**(): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

Defined in: [src/classes/navigation/RoomStoredClass.ts:92](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L92)

The location where the room is.

##### Returns [#returns-5]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

#### Implementation of [#implementation-of-5]

`RoomBaseInternalInterface.location`

***

### routine [#routine]

#### Get Signature [#get-signature-5]

\> **get** **routine**(): [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

Defined in: [src/classes/navigation/RoomStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L48)

Get the character commitments of the room.

##### Returns [#returns-6]

[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

#### Implementation of [#implementation-of-6]

`RoomBaseInternalInterface.routine`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L72)

Connects the activity to the class.

#### Parameters [#parameters-1]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-7]

`void`

#### Implementation of [#implementation-of-7]

`RoomBaseInternalInterface.addActivity`

#### Inherited from [#inherited-from-3]

`NavigationAbstractClass.addActivity`

***

### addCommitment() [#addcommitment]

\> **addCommitment**(`commitment`, `options?`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L51)

Connects the commitment to the class.

#### Parameters [#parameters-2]

##### commitment [#commitment]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to connect to the class.

##### options? [#options-1]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling) = `{}`

#### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-8]

`RoomBaseInternalInterface.addCommitment`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:149](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L149)

Removes the useless activities.

#### Returns [#returns-9]

`void`

#### Implementation of [#implementation-of-9]

`RoomBaseInternalInterface.clearExpiredActivities`

#### Inherited from [#inherited-from-4]

`NavigationAbstractClass.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-10]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Implementation of [#implementation-of-10]

`RoomBaseInternalInterface.getStorageProperty`

#### Inherited from [#inherited-from-5]

`NavigationAbstractClass.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-4]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-11]

`void`

#### Implementation of [#implementation-of-11]

`RoomBaseInternalInterface.migrateOldStorage`

#### Inherited from [#inherited-from-6]

`NavigationAbstractClass.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/classes/navigation/NavigationAbstractClass.ts:134](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/NavigationAbstractClass.ts#L134)

Disconnects the activity from the class.

#### Parameters [#parameters-5]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-12]

`void`

#### Implementation of [#implementation-of-12]

`RoomBaseInternalInterface.removeActivity`

#### Inherited from [#inherited-from-7]

`NavigationAbstractClass.removeActivity`

***

### removeCommitment() [#removecommitment]

\> **removeCommitment**(`commitment`): `void`

Defined in: [src/classes/navigation/RoomStoredClass.ts:88](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/navigation/RoomStoredClass.ts#L88)

Disconnects the commitment from the class.

#### Parameters [#parameters-6]

##### commitment [#commitment-1]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to disconnect from the class.

#### Returns [#returns-13]

`void`

#### Implementation of [#implementation-of-13]

`RoomBaseInternalInterface.removeCommitment`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-7]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-14]

`void`

#### Implementation of [#implementation-of-14]

`RoomBaseInternalInterface.setStorageProperty`

#### Inherited from [#inherited-from-8]

`NavigationAbstractClass.setStorageProperty`


# Class: StageBaseModel (/nqtr/index/classes/StageBaseModel)



Defined in: [src/classes/quest/StageBaseModel.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L6)

## Extends [#extends]

* [`StageStoredClass`](/nqtr/index/classes/StageStoredClass)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new StageBaseModel**(`id`, `props`): `StageBaseModel`

Defined in: [src/classes/quest/StageBaseModel.ts:7](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L7)

#### Parameters [#parameters]

##### id [#id]

`string`

##### props [#props]

[`StageProps`](/nqtr/index/interfaces/StageProps)

#### Returns [#returns]

`StageBaseModel`

#### Overrides [#overrides]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`constructor`](/nqtr/index/classes/StageStoredClass#constructor)

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Inherited from [#inherited-from]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`id`](/nqtr/index/classes/StageStoredClass#id)

## Accessors [#accessors]

### adviceDescription [#advicedescription]

#### Get Signature [#get-signature]

\> **get** **adviceDescription**(): `string`

Defined in: [src/classes/quest/StageBaseModel.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L43)

The advice description of the stage.

##### Returns [#returns-1]

`string`

***

### canStart [#canstart]

#### Get Signature [#get-signature-1]

\> **get** **canStart**(): `boolean`

Defined in: [src/classes/quest/StageBaseModel.ts:94](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L94)

Check if the stage can start.

##### Example [#example]

```ts
export default class Stage extends StageStoredClass {
	override get canStart(): boolean {
		if (this.flagsRequired.length > 0 && !this.flagsRequired.every((flag) => storage.getFlag(flag.flag))) {
			return false;
		}
		return super.canStart;
	}
}
```

##### Returns [#returns-2]

`boolean`

#### Overrides [#overrides-1]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`canStart`](/nqtr/index/classes/StageStoredClass#canstart)

***

### completed [#completed]

#### Get Signature [#get-signature-2]

\> **get** **completed**(): `boolean`

Defined in: [src/classes/quest/StageBaseModel.ts:79](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L79)

Check if the flag and goals are completed.
You can force the completion of the stage by setting the completed property to true.

##### Example [#example-1]

```ts
export default class Stage extends StageStoredClass {
	override get completed(): boolean {
		if (super.completed) {
			return true;
		}
		if (this.flags.length > 0) {
			if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
				return false;
			}
			return true;
		}
		return false;
	}
	override set completed(value: boolean) {
		super.completed = value;
	}
}
```

##### Returns [#returns-3]

`boolean`

#### Set Signature [#set-signature]

\> **set** **completed**(`value`): `void`

Defined in: [src/classes/quest/StageBaseModel.ts:91](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L91)

Check if the flag and goals are completed.
You can force the completion of the stage by setting the completed property to true.

##### Example [#example-2]

```ts
export default class Stage extends StageStoredClass {
	override get completed(): boolean {
		if (super.completed) {
			return true;
		}
		if (this.flags.length > 0) {
			if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
				return false;
			}
			return true;
		}
		return false;
	}
	override set completed(value: boolean) {
		super.completed = value;
	}
}
```

##### Parameters [#parameters-1]

###### value [#value]

`boolean`

##### Returns [#returns-4]

`void`

#### Overrides [#overrides-2]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`completed`](/nqtr/index/classes/StageStoredClass#completed)

***

### deltaDateRequired [#deltadaterequired]

#### Get Signature [#get-signature-3]

\> **get** **deltaDateRequired**(): `number`

Defined in: [src/classes/quest/StageStoredClass.ts:122](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L122)

The number of day/date required to start the stage.

##### Returns [#returns-5]

`number`

#### Inherited from [#inherited-from-1]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`deltaDateRequired`](/nqtr/index/classes/StageStoredClass#deltadaterequired)

***

### description [#description]

#### Get Signature [#get-signature-4]

\> **get** **description**(): `string`

Defined in: [src/classes/quest/StageBaseModel.ts:35](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L35)

The description of the stage.

##### Returns [#returns-6]

`string`

***

### flags [#flags]

#### Get Signature [#get-signature-5]

\> **get** **flags**(): `StageFlags`\[]

Defined in: [src/classes/quest/StageBaseModel.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L59)

The list of flags that the player must complete to finish the stage.

##### Returns [#returns-7]

`StageFlags`\[]

***

### flagsRequired [#flagsrequired]

#### Get Signature [#get-signature-6]

\> **get** **flagsRequired**(): `StageFlags`\[]

Defined in: [src/classes/quest/StageBaseModel.ts:67](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L67)

The list of flags required to start the stage.

##### Returns [#returns-8]

`StageFlags`\[]

***

### image [#image]

#### Get Signature [#get-signature-7]

\> **get** **image**(): `string` | `undefined`

Defined in: [src/classes/quest/StageBaseModel.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L51)

The image of the stage.

##### Returns [#returns-9]

`string` | `undefined`

***

### name [#name]

#### Get Signature [#get-signature-8]

\> **get** **name**(): `string`

Defined in: [src/classes/quest/StageBaseModel.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L27)

The name of the stage.

##### Returns [#returns-10]

`string`

***

### onEnd [#onend]

#### Get Signature [#get-signature-9]

\> **get** **onEnd**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L48)

The function that will be called when the stage ends.

##### Returns [#returns-11]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

#### Inherited from [#inherited-from-2]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`onEnd`](/nqtr/index/classes/StageStoredClass#onend)

***

### onStart [#onstart]

#### Get Signature [#get-signature-10]

\> **get** **onStart**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L43)

The function that will be called when the stage starts.

##### Returns [#returns-12]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

#### Inherited from [#inherited-from-3]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`onStart`](/nqtr/index/classes/StageStoredClass#onstart)

***

### questsRequired [#questsrequired]

#### Get Signature [#get-signature-11]

\> **get** **questsRequired**(): [`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

Defined in: [src/classes/quest/StageStoredClass.ts:127](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L127)

The list of quests required to start the stage.

##### Returns [#returns-13]

[`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

#### Inherited from [#inherited-from-4]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`questsRequired`](/nqtr/index/classes/StageStoredClass#questsrequired)

***

### requestDescriptionToStart [#requestdescriptiontostart]

#### Get Signature [#get-signature-12]

\> **get** **requestDescriptionToStart**(): `string`

Defined in: [src/classes/quest/StageBaseModel.ts:75](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageBaseModel.ts#L75)

The description of the request to start the stage.

##### Returns [#returns-14]

`string`

***

### startDate [#startdate]

#### Get Signature [#get-signature-13]

\> **get** **startDate**(): `number` | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:73](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L73)

The date when the stage starts.

##### Returns [#returns-15]

`number` | `undefined`

#### Inherited from [#inherited-from-5]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`startDate`](/nqtr/index/classes/StageStoredClass#startdate)

***

### started [#started]

#### Get Signature [#get-signature-14]

\> **get** **started**(): `boolean`

Defined in: [src/classes/quest/StageStoredClass.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L59)

If the stage is started.

##### Returns [#returns-16]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **started**(`value`): `void`

Defined in: [src/classes/quest/StageStoredClass.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L62)

If the stage is started.

##### Parameters [#parameters-2]

###### value [#value-1]

`boolean`

##### Returns [#returns-17]

`void`

#### Inherited from [#inherited-from-6]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`started`](/nqtr/index/classes/StageStoredClass#started)

## Methods [#methods]

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-18]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-7]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`getStorageProperty`](/nqtr/index/classes/StageStoredClass#getstorageproperty)

***

### inizialize() [#inizialize]

\> **inizialize**(): `void`

Defined in: [src/classes/quest/StageStoredClass.ts:103](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L103)

#### Returns [#returns-19]

`void`

#### Inherited from [#inherited-from-8]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`inizialize`](/nqtr/index/classes/StageStoredClass#inizialize)

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-4]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-9]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`migrateOldStorage`](/nqtr/index/classes/StageStoredClass#migrateoldstorage)

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-5]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-2]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-10]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`setStorageProperty`](/nqtr/index/classes/StageStoredClass#setstorageproperty)

***

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/StageStoredClass.ts:110](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L110)

The function that will be called when the stage starts.

#### Parameters [#parameters-6]

##### props [#props-1]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-22]

`Promise`\<`void`>

#### Inherited from [#inherited-from-11]

[`StageStoredClass`](/nqtr/index/classes/StageStoredClass).[`start`](/nqtr/index/classes/StageStoredClass#start)


# Class: StageStoredClass (/nqtr/index/classes/StageStoredClass)



Defined in: [src/classes/quest/StageStoredClass.ts:30](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L30)

## Extends [#extends]

* `StoredClassModel`

## Extended by [#extended-by]

* [`StageBaseModel`](/nqtr/index/classes/StageBaseModel)

## Implements [#implements]

* `StageBaseInternalInterface`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new StageStoredClass**(`id`, `props?`): `StageStoredClass`

Defined in: [src/classes/quest/StageStoredClass.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L34)

#### Parameters [#parameters]

##### id [#id]

`string`

##### props? [#props]

[`StageStoredClassProps`](/nqtr/index/interfaces/StageStoredClassProps) = `{}`

#### Returns [#returns]

`StageStoredClass`

#### Overrides [#overrides]

`StoredClassModel.constructor`

## Properties [#properties]

### id [#id-1]

\> `readonly` **id**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41

Is id of the stored class. is unique for this class.

#### Implementation of [#implementation-of]

`StageBaseInternalInterface.id`

#### Inherited from [#inherited-from]

`StoredClassModel.id`

## Accessors [#accessors]

### canStart [#canstart]

#### Get Signature [#get-signature]

\> **get** **canStart**(): `boolean`

Defined in: [src/classes/quest/StageStoredClass.ts:81](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L81)

Check if the stage can start.

##### Example [#example]

```ts
export default class Stage extends StageStoredClass {
	override get canStart(): boolean {
		if (this.flagsRequired.length > 0 && !this.flagsRequired.every((flag) => storage.getFlag(flag.flag))) {
			return false;
		}
		return super.canStart;
	}
}
```

##### Returns [#returns-1]

`boolean`

#### Implementation of [#implementation-of-1]

`StageBaseInternalInterface.canStart`

***

### completed [#completed]

#### Get Signature [#get-signature-1]

\> **get** **completed**(): `boolean`

Defined in: [src/classes/quest/StageStoredClass.ts:52](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L52)

Check if the flag and goals are completed.
You can force the completion of the stage by setting the completed property to true.

##### Example [#example-1]

```ts
export default class Stage extends StageStoredClass {
	override get completed(): boolean {
		if (super.completed) {
			return true;
		}
		if (this.flags.length > 0) {
			if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
				return false;
			}
			return true;
		}
		return false;
	}
	override set completed(value: boolean) {
		super.completed = value;
	}
}
```

##### Returns [#returns-2]

`boolean`

#### Set Signature [#set-signature]

\> **set** **completed**(`value`): `void`

Defined in: [src/classes/quest/StageStoredClass.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L55)

Check if the flag and goals are completed.
You can force the completion of the stage by setting the completed property to true.

##### Example [#example-2]

```ts
export default class Stage extends StageStoredClass {
	override get completed(): boolean {
		if (super.completed) {
			return true;
		}
		if (this.flags.length > 0) {
			if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
				return false;
			}
			return true;
		}
		return false;
	}
	override set completed(value: boolean) {
		super.completed = value;
	}
}
```

##### Parameters [#parameters-1]

###### value [#value]

`boolean`

##### Returns [#returns-3]

`void`

#### Implementation of [#implementation-of-2]

`StageBaseInternalInterface.completed`

***

### deltaDateRequired [#deltadaterequired]

#### Get Signature [#get-signature-2]

\> **get** **deltaDateRequired**(): `number`

Defined in: [src/classes/quest/StageStoredClass.ts:122](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L122)

The number of day/date required to start the stage.

##### Returns [#returns-4]

`number`

#### Implementation of [#implementation-of-3]

`StageBaseInternalInterface.deltaDateRequired`

***

### onEnd [#onend]

#### Get Signature [#get-signature-3]

\> **get** **onEnd**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L48)

The function that will be called when the stage ends.

##### Returns [#returns-5]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

#### Implementation of [#implementation-of-4]

`StageBaseInternalInterface.onEnd`

***

### onStart [#onstart]

#### Get Signature [#get-signature-4]

\> **get** **onStart**(): [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L43)

The function that will be called when the stage starts.

##### Returns [#returns-6]

[`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)> | `undefined`

#### Implementation of [#implementation-of-5]

`StageBaseInternalInterface.onStart`

***

### questsRequired [#questsrequired]

#### Get Signature [#get-signature-5]

\> **get** **questsRequired**(): [`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

Defined in: [src/classes/quest/StageStoredClass.ts:127](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L127)

The list of quests required to start the stage.

##### Returns [#returns-7]

[`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

#### Implementation of [#implementation-of-6]

`StageBaseInternalInterface.questsRequired`

***

### startDate [#startdate]

#### Get Signature [#get-signature-6]

\> **get** **startDate**(): `number` | `undefined`

Defined in: [src/classes/quest/StageStoredClass.ts:73](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L73)

The date when the stage starts.

##### Returns [#returns-8]

`number` | `undefined`

#### Implementation of [#implementation-of-7]

`StageBaseInternalInterface.startDate`

***

### started [#started]

#### Get Signature [#get-signature-7]

\> **get** **started**(): `boolean`

Defined in: [src/classes/quest/StageStoredClass.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L59)

If the stage is started.

##### Returns [#returns-9]

`boolean`

#### Set Signature [#set-signature-1]

\> **set** **started**(`value`): `void`

Defined in: [src/classes/quest/StageStoredClass.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L62)

If the stage is started.

##### Parameters [#parameters-2]

###### value [#value-1]

`boolean`

##### Returns [#returns-10]

`void`

#### Implementation of [#implementation-of-8]

`StageBaseInternalInterface.started`

## Methods [#methods]

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-3]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-11]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-1]

`StoredClassModel.getStorageProperty`

***

### inizialize() [#inizialize]

\> **inizialize**(): `void`

Defined in: [src/classes/quest/StageStoredClass.ts:103](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L103)

#### Returns [#returns-12]

`void`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-4]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-2]

`StoredClassModel.migrateOldStorage`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-5]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value-2]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-14]

`void`

#### Inherited from [#inherited-from-3]

`StoredClassModel.setStorageProperty`

***

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/classes/quest/StageStoredClass.ts:110](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L110)

The function that will be called when the stage starts.

#### Parameters [#parameters-6]

##### props [#props-1]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns-15]

`Promise`\<`void`>

#### Implementation of [#implementation-of-9]

`StageBaseInternalInterface.start`


# index (/nqtr/index)



## Namespaces [#namespaces]

* [RegisteredActivities](/nqtr/index/namespaces/RegisteredActivities)
* [RegisteredCommitments](/nqtr/index/namespaces/RegisteredCommitments)
* [RegisteredLocations](/nqtr/index/namespaces/RegisteredLocations)
* [RegisteredMaps](/nqtr/index/namespaces/RegisteredMaps)
* [RegisteredQuests](/nqtr/index/namespaces/RegisteredQuests)
* [RegisteredRooms](/nqtr/index/namespaces/RegisteredRooms)

## Classes [#classes]

* [ActivityBaseModel](/nqtr/index/classes/ActivityBaseModel)
* [ActivityStoredClass](/nqtr/index/classes/ActivityStoredClass)
* [CommitmentBaseModel](/nqtr/index/classes/CommitmentBaseModel)
* [CommitmentStoredClass](/nqtr/index/classes/CommitmentStoredClass)
* [LocationBaseModel](/nqtr/index/classes/LocationBaseModel)
* [LocationStoredClass](/nqtr/index/classes/LocationStoredClass)
* [MapBaseModel](/nqtr/index/classes/MapBaseModel)
* [MapStoredClass](/nqtr/index/classes/MapStoredClass)
* [QuestBaseModel](/nqtr/index/classes/QuestBaseModel)
* [QuestStoredClass](/nqtr/index/classes/QuestStoredClass)
* [RoomBaseModel](/nqtr/index/classes/RoomBaseModel)
* [RoomStoredClass](/nqtr/index/classes/RoomStoredClass)
* [StageBaseModel](/nqtr/index/classes/StageBaseModel)
* [StageStoredClass](/nqtr/index/classes/StageStoredClass)

## Interfaces [#interfaces]

* [ActiveScheduling](/nqtr/index/interfaces/ActiveScheduling)
* [ActivityInterface](/nqtr/index/interfaces/ActivityInterface)
* [ActivityProps](/nqtr/index/interfaces/ActivityProps)
* [ActivityStoredClassProps](/nqtr/index/interfaces/ActivityStoredClassProps)
* [CommitmentInfo](/nqtr/index/interfaces/CommitmentInfo)
* [CommitmentInterface](/nqtr/index/interfaces/CommitmentInterface)
* [CommitmentProps](/nqtr/index/interfaces/CommitmentProps)
* [CommitmentStoredClassProps](/nqtr/index/interfaces/CommitmentStoredClassProps)
* [DateSchedulingInterface](/nqtr/index/interfaces/DateSchedulingInterface)
* [LocationBaseModelProps](/nqtr/index/interfaces/LocationBaseModelProps)
* [LocationInterface](/nqtr/index/interfaces/LocationInterface)
* [MapBaseModelProps](/nqtr/index/interfaces/MapBaseModelProps)
* [MapInterface](/nqtr/index/interfaces/MapInterface)
* [NqtrActivityIds](/nqtr/index/interfaces/NqtrActivityIds)
* [NqtrCommitmentIds](/nqtr/index/interfaces/NqtrCommitmentIds)
* [NqtrLocationIds](/nqtr/index/interfaces/NqtrLocationIds)
* [NqtrMapIds](/nqtr/index/interfaces/NqtrMapIds)
* [NqtrQuestIds](/nqtr/index/interfaces/NqtrQuestIds)
* [NqtrRoomIds](/nqtr/index/interfaces/NqtrRoomIds)
* [OnRunProps](/nqtr/index/interfaces/OnRunProps)
* [QuestInterface](/nqtr/index/interfaces/QuestInterface)
* [QuestProps](/nqtr/index/interfaces/QuestProps)
* [QuestStoredClassProps](/nqtr/index/interfaces/QuestStoredClassProps)
* [RoomBaseModelProps](/nqtr/index/interfaces/RoomBaseModelProps)
* [RoomInterface](/nqtr/index/interfaces/RoomInterface)
* [StageInterface](/nqtr/index/interfaces/StageInterface)
* [StageProps](/nqtr/index/interfaces/StageProps)
* [StageStoredClassProps](/nqtr/index/interfaces/StageStoredClassProps)
* [TimeSchedulingInterface](/nqtr/index/interfaces/TimeSchedulingInterface)

## Type Aliases [#type-aliases]

* [ActivityIdType](/nqtr/index/type-aliases/ActivityIdType)
* [CommitmentIdType](/nqtr/index/type-aliases/CommitmentIdType)
* [ExecutionType](/nqtr/index/type-aliases/ExecutionType)
* [ITimeStlot](/nqtr/index/type-aliases/ITimeStlot)
* [LocationIdType](/nqtr/index/type-aliases/LocationIdType)
* [MapIdType](/nqtr/index/type-aliases/MapIdType)
* [OnRunAsyncFunction](/nqtr/index/type-aliases/OnRunAsyncFunction)
* [OnRunEvent](/nqtr/index/type-aliases/OnRunEvent)
* [OnRunFunction](/nqtr/index/type-aliases/OnRunFunction)
* [QuestIdType](/nqtr/index/type-aliases/QuestIdType)
* [QuestsRequiredType](/nqtr/index/type-aliases/QuestsRequiredType)
* [RoomIdType](/nqtr/index/type-aliases/RoomIdType)
* [TimeSettings](/nqtr/index/type-aliases/TimeSettings)

## Variables [#variables]

* [default](/nqtr/index/variables/default)
* [navigator](/nqtr/index/variables/navigator)
* [questsNotebook](/nqtr/index/variables/questsNotebook)
* [routine](/nqtr/index/variables/routine)
* [timeTracker](/nqtr/index/variables/timeTracker)


# Interface: ActiveScheduling (/nqtr/index/interfaces/ActiveScheduling)



Defined in: [src/interface/activity/ActiveScheduling.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L4)

## Extended by [#extended-by]

* [`ActivityStoredClassProps`](/nqtr/index/interfaces/ActivityStoredClassProps)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/ActiveScheduling.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L12)

Used to schedule what date it will be added and removed.

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[]

Defined in: [src/interface/activity/ActiveScheduling.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L8)

Time slot in which activity/commitment will be active.


# Interface: ActivityInterface (/nqtr/index/interfaces/ActivityInterface)



Defined in: [src/interface/activity/ActivityInterface.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L3)

## Extends [#extends]

* `ActivityBaseInternalInterface`

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/ActiveScheduling.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L12)

Used to schedule what date it will be added and removed.

#### Inherited from [#inherited-from]

`ActivityBaseInternalInterface.dateScheduling`

***

### expired [#expired]

\> `readonly` **expired**: `boolean`

Defined in: [src/interface/activity/ActivityInterface.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L19)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

#### Inherited from [#inherited-from-1]

`ActivityBaseInternalInterface.expired`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/activity/ActivityInterface.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L9)

The id of the activity/commitment.

#### Inherited from [#inherited-from-2]

`ActivityBaseInternalInterface.id`

***

### run [#run]

\> `readonly` **run**: [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

Defined in: [src/interface/activity/ActivityInterface.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L13)

The function that is called when the activity/commitment is runned.

#### Inherited from [#inherited-from-3]

`ActivityBaseInternalInterface.run`

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[]

Defined in: [src/interface/activity/ActiveScheduling.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L8)

Time slot in which activity/commitment will be active.

#### Inherited from [#inherited-from-4]

`ActivityBaseInternalInterface.timeSlot`

## Methods [#methods]

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/interface/activity/ActivityInterface.ts:24](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L24)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

The options to check if the activity/commitment is active.

#### Returns [#returns]

`boolean`

#### Inherited from [#inherited-from-5]

`ActivityBaseInternalInterface.isActive`


# Interface: ActivityProps (/nqtr/index/interfaces/ActivityProps)



Defined in: [src/interface/activity/ActivityProps.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L4)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/ActivityProps.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L17)

Used to schedule what date it will be added and removed.

***

### disabled? [#disabled]

\> `optional` **disabled?**: `string` | `boolean`

Defined in: [src/interface/activity/ActivityProps.ts:22](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L22)

Whether is disabled. You can also pass a Pixi'VN flag name.

#### Default [#default]

```ts
false
```

***

### hidden? [#hidden]

\> `optional` **hidden?**: `string` | `boolean`

Defined in: [src/interface/activity/ActivityProps.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L27)

Whether is hidden. You can also pass a Pixi'VN flag name.

#### Default [#default-1]

```ts
false
```

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/activity/ActivityProps.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L9)

The name

#### Default [#default-2]

```ts
""
```

***

### renderIcon? [#rendericon]

\> `optional` **renderIcon?**: `string`

Defined in: [src/interface/activity/ActivityProps.ts:32](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L32)

The icon of the activity.

#### Default [#default-3]

```ts
undefined
```

***

### timeSlot? [#timeslot]

\> `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)

Defined in: [src/interface/activity/ActivityProps.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityProps.ts#L13)

Time slot in which activity/commitment will be active.


# Interface: ActivityStoredClassProps (/nqtr/index/interfaces/ActivityStoredClassProps)



Defined in: [src/classes/activity/ActivityStoredClass.ts:10](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/ActivityStoredClass.ts#L10)

## Extends [#extends]

* [`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/ActiveScheduling.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L12)

Used to schedule what date it will be added and removed.

#### Inherited from [#inherited-from]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling).[`dateScheduling`](/nqtr/index/interfaces/ActiveScheduling#datescheduling)

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[]

Defined in: [src/interface/activity/ActiveScheduling.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L8)

Time slot in which activity/commitment will be active.

#### Inherited from [#inherited-from-1]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling).[`timeSlot`](/nqtr/index/interfaces/ActiveScheduling#timeslot)


# Interface: CommitmentInfo (/nqtr/index/interfaces/CommitmentInfo)



Defined in: [src/interface/activity/CommitmentInfo.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInfo.ts#L3)

## Properties [#properties]

### commitment [#commitment]

\> **commitment**: [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

Defined in: [src/interface/activity/CommitmentInfo.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInfo.ts#L4)

***

### roomId [#roomid]

\> **roomId**: `string`

Defined in: [src/interface/activity/CommitmentInfo.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInfo.ts#L5)


# Interface: CommitmentInterface (/nqtr/index/interfaces/CommitmentInterface)



Defined in: [src/interface/activity/CommitmentInterface.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInterface.ts#L5)

## Extends [#extends]

* `CommitmentBaseInternalInterface`

## Properties [#properties]

### characters [#characters]

\> `readonly` **characters**: `CharacterInterface`\[]

Defined in: [src/interface/activity/CommitmentInterface.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInterface.ts#L11)

The character or characters that are in the commitment and so in the room.

#### Inherited from [#inherited-from]

`CommitmentBaseInternalInterface.characters`

***

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/ActiveScheduling.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L12)

Used to schedule what date it will be added and removed.

#### Inherited from [#inherited-from-1]

`CommitmentBaseInternalInterface.dateScheduling`

***

### executionType [#executiontype]

\> **executionType**: [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/interface/activity/CommitmentInterface.ts:16](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInterface.ts#L16)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

#### Inherited from [#inherited-from-2]

`CommitmentBaseInternalInterface.executionType`

***

### expired [#expired]

\> `readonly` **expired**: `boolean`

Defined in: [src/interface/activity/ActivityInterface.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L19)

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It **depends only on the date**, not the time. So if you set \{ dateScheduling: \{ from: 0, to: 3 }, timeSlot \{ from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

#### Inherited from [#inherited-from-3]

`CommitmentBaseInternalInterface.expired`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/activity/ActivityInterface.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L9)

The id of the activity/commitment.

#### Inherited from [#inherited-from-4]

`CommitmentBaseInternalInterface.id`

***

### priority [#priority]

\> **priority**: `number`

Defined in: [src/interface/activity/CommitmentInterface.ts:21](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentInterface.ts#L21)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

#### Inherited from [#inherited-from-5]

`CommitmentBaseInternalInterface.priority`

***

### run [#run]

\> `readonly` **run**: [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)

Defined in: [src/interface/activity/ActivityInterface.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L13)

The function that is called when the activity/commitment is runned.

#### Inherited from [#inherited-from-6]

`CommitmentBaseInternalInterface.run`

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface) | [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)\[]

Defined in: [src/interface/activity/ActiveScheduling.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActiveScheduling.ts#L8)

Time slot in which activity/commitment will be active.

#### Inherited from [#inherited-from-7]

`CommitmentBaseInternalInterface.timeSlot`

## Methods [#methods]

### isActive() [#isactive]

\> **isActive**(`options?`): `boolean`

Defined in: [src/interface/activity/ActivityInterface.ts:24](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/ActivityInterface.ts#L24)

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

#### Parameters [#parameters]

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

The options to check if the activity/commitment is active.

#### Returns [#returns]

`boolean`

#### Inherited from [#inherited-from-8]

`CommitmentBaseInternalInterface.isActive`


# Interface: CommitmentProps (/nqtr/index/interfaces/CommitmentProps)



Defined in: [src/interface/activity/CommitmentProps.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L6)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `readonly` `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/interface/activity/CommitmentProps.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L19)

Used to schedule what date it will be added and removed.

***

### disabled? [#disabled]

\> `optional` **disabled?**: `string` | `boolean`

Defined in: [src/interface/activity/CommitmentProps.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L42)

Whether is disabled. You can also pass a Pixi'VN flag name.
If it is disabled this commitment will not be taken into consideration. So the characters will not be in the room, but will be busy with other commitments.

#### Default [#default]

```ts
false
```

***

### executionType? [#executiontype]

\> `optional` **executionType?**: [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/interface/activity/CommitmentProps.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L29)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

#### Default [#default-1]

```ts
"interaction"
```

***

### hidden? [#hidden]

\> `optional` **hidden?**: `string` | `boolean`

Defined in: [src/interface/activity/CommitmentProps.ts:47](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L47)

Whether is hidden. You can also pass a Pixi'VN flag name.

#### Default [#default-2]

```ts
false
```

***

### icon? [#icon]

\> `optional` **icon?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L51)

The icon of the commitment.

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L23)

The image ofthe Commitment.

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/activity/CommitmentProps.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L11)

The name

#### Default [#default-3]

```ts
""
```

***

### onRun? [#onrun]

\> `optional` **onRun?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)>

Defined in: [src/interface/activity/CommitmentProps.ts:36](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L36)

Is a function that is called when the player interacts with the character.

#### Param [#param]

**commitment**

#### Returns [#returns]

#### Default [#default-4]

```ts
undefined
```

***

### priority? [#priority]

\> `optional` **priority?**: `number`

Defined in: [src/interface/activity/CommitmentProps.ts:57](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L57)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

#### Default [#default-5]

```ts
0
```

***

### timeSlot? [#timeslot]

\> `readonly` `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)

Defined in: [src/interface/activity/CommitmentProps.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/activity/CommitmentProps.ts#L15)

Time slot in which activity/commitment will be active.


# Interface: CommitmentStoredClassProps (/nqtr/index/interfaces/CommitmentStoredClassProps)



Defined in: [src/classes/activity/CommitmentStoredClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L19)

## Properties [#properties]

### dateScheduling? [#datescheduling]

\> `optional` **dateScheduling?**: [`DateSchedulingInterface`](/nqtr/index/interfaces/DateSchedulingInterface)

Defined in: [src/classes/activity/CommitmentStoredClass.ts:37](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L37)

Used to schedule what date it will be added and removed.

***

### executionType? [#executiontype]

\> `optional` **executionType?**: [`ExecutionType`](/nqtr/index/type-aliases/ExecutionType)

Defined in: [src/classes/activity/CommitmentStoredClass.ts:24](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L24)

Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.

***

### priority? [#priority]

\> `optional` **priority?**: `number`

Defined in: [src/classes/activity/CommitmentStoredClass.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L29)

The priority. The higher the number, the higher the priority.
To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.

***

### timeSlot? [#timeslot]

\> `optional` **timeSlot?**: [`TimeSchedulingInterface`](/nqtr/index/interfaces/TimeSchedulingInterface)

Defined in: [src/classes/activity/CommitmentStoredClass.ts:33](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/activity/CommitmentStoredClass.ts#L33)

Time slot in which activity/commitment will be active.


# Interface: DateSchedulingInterface (/nqtr/index/interfaces/DateSchedulingInterface)



Defined in: [src/interface/DateSchedulingInterface.ts:1](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/DateSchedulingInterface.ts#L1)

## Properties [#properties]

### from [#from]

\> **from**: `number`

Defined in: [src/interface/DateSchedulingInterface.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/DateSchedulingInterface.ts#L6)

The start date. If the item hasn't started yet, it will be hidden.
If you set it to 3, the item will be hidden on dates 1 and 2 and will be shown starting on date 3.

***

### to? [#to]

\> `optional` **to?**: `number`

Defined in: [src/interface/DateSchedulingInterface.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/DateSchedulingInterface.ts#L12)

The date when the item ends. If the item is ended yet, it will be deleted or hidden.
If you set \{ from: 0, to: 3 }, the item will be shown into dates 1 and 2 and will be deleted or hidden from date 3.

#### Default [#default]

```ts
undefined
```


# Interface: LocationBaseModelProps (/nqtr/index/interfaces/LocationBaseModelProps)



Defined in: [src/interface/navigation/LocationBaseModelProps.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L3)

## Properties [#properties]

### activities? [#activities]

\> `optional` **activities?**: (`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[]

Defined in: [src/interface/navigation/LocationBaseModelProps.ts:28](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L28)

The activities that are available in this location.

#### Default [#default]

```ts
[]
```

***

### disabled? [#disabled]

\> `optional` **disabled?**: `string` | `boolean`

Defined in: [src/interface/navigation/LocationBaseModelProps.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L13)

Whether is disabled. You can also pass a Pixi'VN flag name.

#### Default [#default-1]

```ts
false
```

***

### hidden? [#hidden]

\> `optional` **hidden?**: `string` | `boolean`

Defined in: [src/interface/navigation/LocationBaseModelProps.ts:18](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L18)

Whether is hidden. You can also pass a Pixi'VN flag name.

#### Default [#default-2]

```ts
false
```

***

### icon? [#icon]

\> `optional` **icon?**: `string`

Defined in: [src/interface/navigation/LocationBaseModelProps.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L23)

The icon of the location.

#### Default [#default-3]

```ts
undefined
```

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/navigation/LocationBaseModelProps.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationBaseModelProps.ts#L8)

The name

#### Default [#default-4]

```ts
""
```


# Interface: LocationInterface (/nqtr/index/interfaces/LocationInterface)



Defined in: [src/interface/navigation/LocationInterface.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationInterface.ts#L5)

## Extends [#extends]

* `LocationInternalInterface`

## Properties [#properties]

### activities [#activities]

\> **activities**: [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L31)

The activities associated with this class, filtered based on their scheduling.

#### Inherited from [#inherited-from]

`LocationInternalInterface.activities`

***

### activitiesIds [#activitiesids]

\> `readonly` **activitiesIds**: `string`\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L27)

All the ids of the activities associated with this class. Compared to [activities](#activities), they are not filtered based on their scheduling.

#### Inherited from [#inherited-from-1]

`LocationInternalInterface.activitiesIds`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/navigation/LocationInterface.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationInterface.ts#L11)

The id of the location.

#### Inherited from [#inherited-from-2]

`LocationInternalInterface.id`

***

### map [#map]

\> `readonly` **map**: [`MapInterface`](/nqtr/index/interfaces/MapInterface)

Defined in: [src/interface/navigation/LocationInterface.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationInterface.ts#L15)

The map where the location is.

#### Inherited from [#inherited-from-3]

`LocationInternalInterface.map`

***

### rooms [#rooms]

\> `readonly` **rooms**: [`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

Defined in: [src/interface/navigation/LocationInterface.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/LocationInterface.ts#L20)

Get all rooms in the location.

#### Returns [#returns]

The rooms in the location.

#### Inherited from [#inherited-from-4]

`LocationInternalInterface.rooms`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L13)

Connects the activity to the class.

#### Parameters [#parameters]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-5]

`LocationInternalInterface.addActivity`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L23)

Removes the useless activities.

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-6]

`LocationInternalInterface.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-1]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-3]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-7]

`LocationInternalInterface.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-2]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-8]

`LocationInternalInterface.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L19)

Disconnects the activity from the class.

#### Parameters [#parameters-3]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-5]

`void`

#### Inherited from [#inherited-from-9]

`LocationInternalInterface.removeActivity`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-4]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-6]

`void`

#### Inherited from [#inherited-from-10]

`LocationInternalInterface.setStorageProperty`


# Interface: MapBaseModelProps (/nqtr/index/interfaces/MapBaseModelProps)



Defined in: [src/interface/navigation/MapBaseModelProps.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapBaseModelProps.ts#L3)

## Properties [#properties]

### activities? [#activities]

\> `optional` **activities?**: (`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[]

Defined in: [src/interface/navigation/MapBaseModelProps.ts:18](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapBaseModelProps.ts#L18)

The activities that are available in this map.

#### Default [#default]

```ts
[]
```

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/navigation/MapBaseModelProps.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapBaseModelProps.ts#L13)

The image of the map.

#### Default [#default-1]

```ts
undefined
```

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/navigation/MapBaseModelProps.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapBaseModelProps.ts#L8)

The name

#### Default [#default-2]

```ts
""
```


# Interface: MapInterface (/nqtr/index/interfaces/MapInterface)



Defined in: [src/interface/navigation/MapInterface.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapInterface.ts#L4)

## Extends [#extends]

* `MapBaseInternalInterface`

## Properties [#properties]

### activities [#activities]

\> **activities**: [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L31)

The activities associated with this class, filtered based on their scheduling.

#### Inherited from [#inherited-from]

`MapBaseInternalInterface.activities`

***

### activitiesIds [#activitiesids]

\> `readonly` **activitiesIds**: `string`\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L27)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

#### Inherited from [#inherited-from-1]

`MapBaseInternalInterface.activitiesIds`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/navigation/MapInterface.ts:10](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapInterface.ts#L10)

The id of the map.

#### Inherited from [#inherited-from-2]

`MapBaseInternalInterface.id`

***

### locations [#locations]

\> `readonly` **locations**: [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

Defined in: [src/interface/navigation/MapInterface.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/MapInterface.ts#L15)

Get all locations in the map.

#### Returns [#returns]

The locations in the map.

#### Inherited from [#inherited-from-3]

`MapBaseInternalInterface.locations`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L13)

Connects the activity to the class.

#### Parameters [#parameters]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-4]

`MapBaseInternalInterface.addActivity`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L23)

Removes the useless activities.

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-5]

`MapBaseInternalInterface.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-1]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-3]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-6]

`MapBaseInternalInterface.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-2]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-7]

`MapBaseInternalInterface.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L19)

Disconnects the activity from the class.

#### Parameters [#parameters-3]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-5]

`void`

#### Inherited from [#inherited-from-8]

`MapBaseInternalInterface.removeActivity`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-4]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-6]

`void`

#### Inherited from [#inherited-from-9]

`MapBaseInternalInterface.setStorageProperty`


# Interface: NqtrActivityIds (/nqtr/index/interfaces/NqtrActivityIds)



Defined in: [src/registries/NqtrIds.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L8)


# Interface: NqtrCommitmentIds (/nqtr/index/interfaces/NqtrCommitmentIds)



Defined in: [src/registries/NqtrIds.ts:10](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L10)


# Interface: NqtrLocationIds (/nqtr/index/interfaces/NqtrLocationIds)



Defined in: [src/registries/NqtrIds.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L12)


# Interface: NqtrMapIds (/nqtr/index/interfaces/NqtrMapIds)



Defined in: [src/registries/NqtrIds.ts:14](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L14)


# Interface: NqtrQuestIds (/nqtr/index/interfaces/NqtrQuestIds)



Defined in: [src/registries/NqtrIds.ts:16](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L16)


# Interface: NqtrRoomIds (/nqtr/index/interfaces/NqtrRoomIds)



Defined in: [src/registries/NqtrIds.ts:18](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L18)


# Interface: OnRunProps (/nqtr/index/interfaces/OnRunProps)



Defined in: [src/types/OnRunEvent.ts:1](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/OnRunEvent.ts#L1)


# Interface: QuestInterface (/nqtr/index/interfaces/QuestInterface)



Defined in: [src/interface/quest/QuestInterface.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L5)

## Extends [#extends]

* `QuestBaseInternalInterface`

## Properties [#properties]

### completed [#completed]

\> `readonly` **completed**: `boolean`

Defined in: [src/interface/quest/QuestInterface.ts:40](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L40)

If the quest is completed.

#### Inherited from [#inherited-from]

`QuestBaseInternalInterface.completed`

***

### currentStage? [#currentstage]

\> `readonly` `optional` **currentStage?**: [`StageInterface`](/nqtr/index/interfaces/StageInterface)

Defined in: [src/interface/quest/QuestInterface.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L25)

The current stage.

#### Inherited from [#inherited-from-1]

`QuestBaseInternalInterface.currentStage`

***

### currentStageIndex? [#currentstageindex]

\> `optional` **currentStageIndex?**: `number`

Defined in: [src/interface/quest/QuestInterface.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L20)

The index of the current stage.

#### Inherited from [#inherited-from-2]

`QuestBaseInternalInterface.currentStageIndex`

***

### currentStageMustStart [#currentstagemuststart]

\> `readonly` **currentStageMustStart**: `boolean`

Defined in: [src/interface/quest/QuestInterface.ts:95](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L95)

If the current stage must start. It is true if the current stage is not started, can start and not completed.

#### Inherited from [#inherited-from-3]

`QuestBaseInternalInterface.currentStageMustStart`

***

### failed [#failed]

\> `readonly` **failed**: `boolean`

Defined in: [src/interface/quest/QuestInterface.ts:45](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L45)

If the quest is failed.

#### Inherited from [#inherited-from-4]

`QuestBaseInternalInterface.failed`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/quest/QuestInterface.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L11)

The id of the quest.

#### Inherited from [#inherited-from-5]

`QuestBaseInternalInterface.id`

***

### inProgress [#inprogress]

\> `readonly` **inProgress**: `boolean`

Defined in: [src/interface/quest/QuestInterface.ts:35](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L35)

If the quest is started and not completed and not failed.

#### Inherited from [#inherited-from-6]

`QuestBaseInternalInterface.inProgress`

***

### onContinue? [#oncontinue]

\> `readonly` `optional` **onContinue?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`QuestInterface`>

Defined in: [src/interface/quest/QuestInterface.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L59)

The function that will be called when the quest goes to the next stage.

#### Inherited from [#inherited-from-7]

`QuestBaseInternalInterface.onContinue`

***

### ~~onNextStage?~~ [#onnextstage]

\> `readonly` `optional` **onNextStage?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`QuestInterface`>

Defined in: [src/interface/quest/QuestInterface.ts:55](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L55)

#### Deprecated [#deprecated]

Use [onContinue](#oncontinue) instead. The function that will be called when the quest goes to the next stage.

#### Inherited from [#inherited-from-8]

`QuestBaseInternalInterface.onNextStage`

***

### onStart? [#onstart]

\> `readonly` `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`QuestInterface`>

Defined in: [src/interface/quest/QuestInterface.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L50)

The function that will be called when the quest starts.

#### Inherited from [#inherited-from-9]

`QuestBaseInternalInterface.onStart`

***

### stages [#stages]

\> `readonly` **stages**: [`StageInterface`](/nqtr/index/interfaces/StageInterface)\[]

Defined in: [src/interface/quest/QuestInterface.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L15)

The stages of the quest.

#### Inherited from [#inherited-from-10]

`QuestBaseInternalInterface.stages`

***

### started [#started]

\> `readonly` **started**: `boolean`

Defined in: [src/interface/quest/QuestInterface.ts:30](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L30)

If the quest is started.

#### Inherited from [#inherited-from-11]

`QuestBaseInternalInterface.started`

## Methods [#methods]

### advanceIfCompleted() [#advanceifcompleted]

\> **advanceIfCompleted**(`props`): `Promise`\<`boolean`>

Defined in: [src/interface/quest/QuestInterface.ts:74](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L74)

Go to the next stage if the current stage is completed.
If you want to force the change of stage, use [advanceUnconditionally](#advanceunconditionally).

#### Parameters [#parameters]

##### props [#props]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-12]

`QuestBaseInternalInterface.advanceIfCompleted`

***

### advanceUnconditionally() [#advanceunconditionally]

\> **advanceUnconditionally**(`props`): `Promise`\<`boolean`>

Defined in: [src/interface/quest/QuestInterface.ts:90](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L90)

Ignore the completed state of the current stage and go to the next stage without checking if the current stage is completed.
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](#advanceifcompleted).

#### Parameters [#parameters-1]

##### props [#props-1]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-1]

`Promise`\<`boolean`>

returns true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-13]

`QuestBaseInternalInterface.advanceUnconditionally`

***

### continue() [#continue]

\> **continue**(`props`): `Promise`\<`boolean`>

Defined in: [src/interface/quest/QuestInterface.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L82)

Complete the current stage and go to the next stage with [advanceUnconditionally](#advanceunconditionally).
If you want to go to the next stage only if the current stage is completed, use [advanceIfCompleted](#advanceifcompleted).

#### Parameters [#parameters-2]

##### props [#props-2]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-2]

`Promise`\<`boolean`>

true if the stage was changed, false otherwise.

#### Inherited from [#inherited-from-14]

`QuestBaseInternalInterface.continue`

***

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/interface/quest/QuestInterface.ts:66](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L66)

Start the quest.

#### Parameters [#parameters-3]

##### props [#props-3]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-3]

`Promise`\<`void`>

#### Inherited from [#inherited-from-15]

`QuestBaseInternalInterface.start`

***

### startCurrentStage() [#startcurrentstage]

\> **startCurrentStage**(`props`): `Promise`\<`void`>

Defined in: [src/interface/quest/QuestInterface.ts:101](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestInterface.ts#L101)

Start the current stage. This is a system function, do not use it directly.

#### Parameters [#parameters-4]

##### props [#props-4]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

The properties for the start stage. If you not want to pass any property, you can pass an \{}.

#### Returns [#returns-4]

`Promise`\<`void`>

#### Inherited from [#inherited-from-16]

`QuestBaseInternalInterface.startCurrentStage`


# Interface: QuestProps (/nqtr/index/interfaces/QuestProps)



Defined in: [src/interface/quest/QuestProps.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L4)

## Properties [#properties]

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/interface/quest/QuestProps.ts:14](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L14)

The description of the quest.

#### Default [#default]

```ts
""
```

***

### icon? [#icon]

\> `optional` **icon?**: `string`

Defined in: [src/interface/quest/QuestProps.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L19)

The icon of the quest.

#### Default [#default-1]

```ts
undefined
```

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/quest/QuestProps.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L23)

The image of the quest.

***

### inDevelopment? [#indevelopment]

\> `optional` **inDevelopment?**: `boolean`

Defined in: [src/interface/quest/QuestProps.ts:28](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L28)

If the quest is in development.

#### Default [#default-2]

```ts
false
```

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/quest/QuestProps.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L9)

The name of the quest.

#### Default [#default-3]

```ts
""
```

***

### onContinue? [#oncontinue]

\> `optional` **onContinue?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/interface/quest/QuestProps.ts:40](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L40)

The function that will be executed when a stage end in the quest.

***

### ~~onNextStage?~~ [#onnextstage]

\> `optional` **onNextStage?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/interface/quest/QuestProps.ts:36](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L36)

#### Deprecated [#deprecated]

Use [onContinue](#oncontinue) instead. The function that will be executed when a stage end in the quest.

***

### onStart? [#onstart]

\> `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/interface/quest/QuestProps.ts:32](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/QuestProps.ts#L32)

The function that will be executed when the quest starts.


# Interface: QuestStoredClassProps (/nqtr/index/interfaces/QuestStoredClassProps)



Defined in: [src/classes/quest/QuestStoredClass.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L9)

## Properties [#properties]

### onContinue? [#oncontinue]

\> `optional` **onContinue?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/classes/quest/QuestStoredClass.ts:21](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L21)

The function that will be executed when a stage end in the quest.

***

### ~~onNextStage?~~ [#onnextstage]

\> `optional` **onNextStage?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/classes/quest/QuestStoredClass.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L17)

#### Deprecated [#deprecated]

Use [onContinue](#oncontinue) instead.

***

### onStart? [#onstart]

\> `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)>

Defined in: [src/classes/quest/QuestStoredClass.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/QuestStoredClass.ts#L13)

The function that will be executed when the quest starts.


# Interface: RoomBaseModelProps (/nqtr/index/interfaces/RoomBaseModelProps)



Defined in: [src/interface/navigation/RoomBaseModelProps.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L8)

## Properties [#properties]

### activities? [#activities]

\> `optional` **activities?**: (`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface))\[]

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L23)

The activities that are available in this room.

#### Default [#default]

```ts
[]
```

***

### disabled? [#disabled]

\> `optional` **disabled?**: `string` | `boolean`

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:33](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L33)

Whether is disabled. You can also pass a Pixi'VN flag name.

#### Default [#default-1]

```ts
false
```

***

### hidden? [#hidden]

\> `optional` **hidden?**: `string` | `boolean`

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L38)

Whether is hidden. You can also pass a Pixi'VN flag name.

#### Default [#default-2]

```ts
false
```

***

### icon? [#icon]

\> `optional` **icon?**: `string`

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:43](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L43)

The icon of the room.

#### Default [#default-3]

```ts
undefined
```

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:18](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L18)

The image of the room.

#### Default [#default-4]

```ts
undefined
```

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L13)

The name

#### Default [#default-5]

```ts
""
```

***

### routine? [#routine]

\> `optional` **routine?**: (`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface))\[]

Defined in: [src/interface/navigation/RoomBaseModelProps.ts:28](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomBaseModelProps.ts#L28)

The routine of the room, it is an array of commitments that are executed in the room. You can also add commitments during the game session, but this property is useful to set the initial routine of the room.

#### Default [#default-6]

```ts
undefined
```


# Interface: RoomInterface (/nqtr/index/interfaces/RoomInterface)



Defined in: [src/interface/navigation/RoomInterface.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L8)

## Extends [#extends]

* `RoomBaseInternalInterface`

## Properties [#properties]

### activities [#activities]

\> **activities**: [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L31)

The activities associated with this class, filtered based on their scheduling.

#### Inherited from [#inherited-from]

`RoomBaseInternalInterface.activities`

***

### activitiesIds [#activitiesids]

\> `readonly` **activitiesIds**: `string`\[]

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L27)

All the ids of the activities associated with this class. Compared to [activities](/nqtr/index/interfaces/LocationInterface#activities), they are not filtered based on their scheduling.

#### Inherited from [#inherited-from-1]

`RoomBaseInternalInterface.activitiesIds`

***

### automaticFunctions [#automaticfunctions]

\> `readonly` **automaticFunctions**: [`OnRunAsyncFunction`](/nqtr/index/type-aliases/OnRunAsyncFunction)\[]

Defined in: [src/interface/navigation/RoomInterface.ts:46](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L46)

Get the functions that will be executed when the room is visited.

#### Inherited from [#inherited-from-2]

`RoomBaseInternalInterface.automaticFunctions`

***

### characters [#characters]

\> `readonly` **characters**: `CharacterInterface`\[]

Defined in: [src/interface/navigation/RoomInterface.ts:42](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L42)

Get the characters in the room.

#### Inherited from [#inherited-from-3]

`RoomBaseInternalInterface.characters`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/navigation/RoomInterface.ts:14](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L14)

The id of the room.

#### Inherited from [#inherited-from-4]

`RoomBaseInternalInterface.id`

***

### location [#location]

\> `readonly` **location**: [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)

Defined in: [src/interface/navigation/RoomInterface.ts:18](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L18)

The location where the room is.

#### Inherited from [#inherited-from-5]

`RoomBaseInternalInterface.location`

***

### routine [#routine]

\> `readonly` **routine**: [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

Defined in: [src/interface/navigation/RoomInterface.ts:38](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L38)

Get the character commitments of the room.

#### Inherited from [#inherited-from-6]

`RoomBaseInternalInterface.routine`

## Methods [#methods]

### addActivity() [#addactivity]

\> **addActivity**(`activity`, `options?`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:13](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L13)

Connects the activity to the class.

#### Parameters [#parameters]

##### activity [#activity]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to connect to the class.

##### options? [#options]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-7]

`RoomBaseInternalInterface.addActivity`

***

### addCommitment() [#addcommitment]

\> **addCommitment**(`commitment`, `options?`): `void`

Defined in: [src/interface/navigation/RoomInterface.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L25)

Connects the commitment to the class.

#### Parameters [#parameters-1]

##### commitment [#commitment]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to connect to the class.

##### options? [#options-1]

[`ActiveScheduling`](/nqtr/index/interfaces/ActiveScheduling)

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-8]

`RoomBaseInternalInterface.addCommitment`

***

### clearExpiredActivities() [#clearexpiredactivities]

\> **clearExpiredActivities**(): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:23](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L23)

Removes the useless activities.

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-9]

`RoomBaseInternalInterface.clearExpiredActivities`

***

### getStorageProperty() [#getstorageproperty]

\> `protected` **getStorageProperty**\<`T`>(`propertyName`, `idToUse?`): `T` | `undefined`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56

Get a property from the storage.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `StorageElementType`

#### Parameters [#parameters-2]

##### propertyName [#propertyname]

`string`

The name of the property to get.

##### idToUse? [#idtouse]

`string`

The id of the instance to get the property.

#### Returns [#returns-3]

`T` | `undefined`

The value of the property. If the property is not found, returns undefined.

#### Default [#default]

```ts
this.id
```

#### Inherited from [#inherited-from-10]

`RoomBaseInternalInterface.getStorageProperty`

***

### migrateOldStorage() [#migrateoldstorage]

\> `protected` **migrateOldStorage**(`oldCategoryId?`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37

#### Parameters [#parameters-3]

##### oldCategoryId? [#oldcategoryid]

`string`

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-11]

`RoomBaseInternalInterface.migrateOldStorage`

***

### removeActivity() [#removeactivity]

\> **removeActivity**(`activity`): `void`

Defined in: [src/interface/navigation/NavigationAbstractClass.ts:19](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/NavigationAbstractClass.ts#L19)

Disconnects the activity from the class.

#### Parameters [#parameters-4]

##### activity [#activity-1]

`string` | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)

The activity to disconnect from the class.

#### Returns [#returns-5]

`void`

#### Inherited from [#inherited-from-12]

`RoomBaseInternalInterface.removeActivity`

***

### removeCommitment() [#removecommitment]

\> **removeCommitment**(`commitment`): `void`

Defined in: [src/interface/navigation/RoomInterface.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/navigation/RoomInterface.ts#L34)

Disconnects the commitment from the class.

#### Parameters [#parameters-5]

##### commitment [#commitment-1]

`string` | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)

The commitment to disconnect from the class.

#### Returns [#returns-6]

`void`

#### Inherited from [#inherited-from-13]

`RoomBaseInternalInterface.removeCommitment`

***

### setStorageProperty() [#setstorageproperty]

\> `protected` **setStorageProperty**\<`T`>(`propertyName`, `value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49

Update a property in the storage.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T`

The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)

#### Parameters [#parameters-6]

##### propertyName [#propertyname-1]

`string`

The name of the property to set.

##### value [#value]

`StorageElementType`

The value to set. If is undefined, the property will be removed from the storage.

#### Returns [#returns-7]

`void`

#### Inherited from [#inherited-from-14]

`RoomBaseInternalInterface.setStorageProperty`


# Interface: StageInterface (/nqtr/index/interfaces/StageInterface)



Defined in: [src/interface/quest/StageInterface.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L5)

## Extends [#extends]

* `StageBaseInternalInterface`

## Properties [#properties]

### canStart [#canstart]

\> `readonly` **canStart**: `boolean`

Defined in: [src/interface/quest/StageInterface.ts:72](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L72)

Check if the stage can start.

#### Example [#example]

```ts
export default class Stage extends StageStoredClass {
	override get canStart(): boolean {
		if (this.flagsRequired.length > 0 && !this.flagsRequired.every((flag) => storage.getFlag(flag.flag))) {
			return false;
		}
		return super.canStart;
	}
}
```

#### Inherited from [#inherited-from]

`StageBaseInternalInterface.canStart`

***

### completed [#completed]

\> **completed**: `boolean`

Defined in: [src/interface/quest/StageInterface.ts:46](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L46)

Check if the flag and goals are completed.
You can force the completion of the stage by setting the completed property to true.

#### Example [#example-1]

```ts
export default class Stage extends StageStoredClass {
	override get completed(): boolean {
		if (super.completed) {
			return true;
		}
		if (this.flags.length > 0) {
			if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
				return false;
			}
			return true;
		}
		return false;
	}
	override set completed(value: boolean) {
		super.completed = value;
	}
}
```

#### Inherited from [#inherited-from-1]

`StageBaseInternalInterface.completed`

***

### deltaDateRequired [#deltadaterequired]

\> `readonly` **deltaDateRequired**: `number`

Defined in: [src/interface/quest/StageInterface.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L82)

The number of day/date required to start the stage.

#### Inherited from [#inherited-from-2]

`StageBaseInternalInterface.deltaDateRequired`

***

### id [#id]

\> `readonly` **id**: `string`

Defined in: [src/interface/quest/StageInterface.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L11)

The id of the stage.

#### Inherited from [#inherited-from-3]

`StageBaseInternalInterface.id`

***

### onEnd? [#onend]

\> `readonly` `optional` **onEnd?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`StageInterface`>

Defined in: [src/interface/quest/StageInterface.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L20)

The function that will be called when the stage ends.

#### Inherited from [#inherited-from-4]

`StageBaseInternalInterface.onEnd`

***

### onStart? [#onstart]

\> `readonly` `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<`StageInterface`>

Defined in: [src/interface/quest/StageInterface.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L15)

The function that will be called when the stage starts.

#### Inherited from [#inherited-from-5]

`StageBaseInternalInterface.onStart`

***

### questsRequired [#questsrequired]

\> `readonly` **questsRequired**: [`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

Defined in: [src/interface/quest/StageInterface.ts:87](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L87)

The list of quests required to start the stage.

#### Inherited from [#inherited-from-6]

`StageBaseInternalInterface.questsRequired`

***

### startDate? [#startdate]

\> `readonly` `optional` **startDate?**: `number`

Defined in: [src/interface/quest/StageInterface.ts:56](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L56)

The date when the stage starts.

#### Inherited from [#inherited-from-7]

`StageBaseInternalInterface.startDate`

***

### started [#started]

\> **started**: `boolean`

Defined in: [src/interface/quest/StageInterface.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L51)

If the stage is started.

#### Inherited from [#inherited-from-8]

`StageBaseInternalInterface.started`

## Methods [#methods]

### start() [#start]

\> **start**(`props`): `Promise`\<`void`>

Defined in: [src/interface/quest/StageInterface.ts:77](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageInterface.ts#L77)

The function that will be called when the stage starts.

#### Parameters [#parameters]

##### props [#props]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

#### Returns [#returns]

`Promise`\<`void`>

#### Inherited from [#inherited-from-9]

`StageBaseInternalInterface.start`


# Interface: StageProps (/nqtr/index/interfaces/StageProps)



Defined in: [src/interface/quest/StageProps.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L5)

## Properties [#properties]

### adviceDescription? [#advicedescription]

\> `optional` **adviceDescription?**: `string`

Defined in: [src/interface/quest/StageProps.ts:25](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L25)

The advice description of the stage.

#### Default [#default]

```ts
""
```

***

### deltaDateRequired? [#deltadaterequired]

\> `optional` **deltaDateRequired?**: `number`

Defined in: [src/interface/quest/StageProps.ts:34](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L34)

The number of day/date required to start the stage.

#### Example [#example]

```ts
If the value is 3, and the previous stage ends on date 1, the stage will start on date 4.
```

***

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/interface/quest/StageProps.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L20)

The description of the stage.

#### Default [#default-1]

```ts
""
```

***

### flags? [#flags]

\> `optional` **flags?**: `StageFlags`\[]

Defined in: [src/interface/quest/StageProps.ts:10](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L10)

The flags of the stage.

#### Default [#default-2]

```ts
[]
```

***

### flagsRequired? [#flagsrequired]

\> `optional` **flagsRequired?**: `StageFlags`\[]

Defined in: [src/interface/quest/StageProps.ts:39](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L39)

The flags required to start the stage.

#### Default [#default-3]

```ts
[]
```

***

### image? [#image]

\> `optional` **image?**: `string`

Defined in: [src/interface/quest/StageProps.ts:29](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L29)

The image of the stage.

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: [src/interface/quest/StageProps.ts:15](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L15)

The name of the stage.

#### Default [#default-4]

```ts
""
```

***

### onEnd? [#onend]

\> `optional` **onEnd?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)>

Defined in: [src/interface/quest/StageProps.ts:57](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L57)

The function that will be executed when the stage ends.

***

### onStart? [#onstart]

\> `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)>

Defined in: [src/interface/quest/StageProps.ts:53](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L53)

The function that will be executed when the stage starts.

***

### questsRequired? [#questsrequired]

\> `optional` **questsRequired?**: [`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

Defined in: [src/interface/quest/StageProps.ts:44](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L44)

The quests required to start the stage.

#### Default [#default-5]

```ts
[]
```

***

### requestDescriptionToStart? [#requestdescriptiontostart]

\> `optional` **requestDescriptionToStart?**: `string`

Defined in: [src/interface/quest/StageProps.ts:49](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/quest/StageProps.ts#L49)

The description to request to start the stage.

#### Default [#default-6]

```ts
""
```


# Interface: StageStoredClassProps (/nqtr/index/interfaces/StageStoredClassProps)



Defined in: [src/classes/quest/StageStoredClass.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L8)

## Properties [#properties]

### deltaDateRequired? [#deltadaterequired]

\> `optional` **deltaDateRequired?**: `number`

Defined in: [src/classes/quest/StageStoredClass.ts:21](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L21)

The number of day/date required to start the stage.

#### Example [#example]

```ts
If the value is 3, and the previous stage ends on day 1, the stage will start on day 4.
```

***

### onEnd? [#onend]

\> `optional` **onEnd?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)>

Defined in: [src/classes/quest/StageStoredClass.ts:16](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L16)

The function that will be executed when the stage ends.

***

### onStart? [#onstart]

\> `optional` **onStart?**: [`OnRunEvent`](/nqtr/index/type-aliases/OnRunEvent)\<[`StageInterface`](/nqtr/index/interfaces/StageInterface)>

Defined in: [src/classes/quest/StageStoredClass.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L12)

The function that will be executed when the stage starts.

***

### questsRequired? [#questsrequired]

\> `optional` **questsRequired?**: [`QuestsRequiredType`](/nqtr/index/type-aliases/QuestsRequiredType)\[]

Defined in: [src/classes/quest/StageStoredClass.ts:26](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/classes/quest/StageStoredClass.ts#L26)

The quests required to start the stage.

#### Default [#default]

```ts
[]
```


# Interface: TimeSchedulingInterface (/nqtr/index/interfaces/TimeSchedulingInterface)



Defined in: [src/interface/TimeSchedulingInterface.ts:1](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/TimeSchedulingInterface.ts#L1)

## Properties [#properties]

### from [#from]

\> **from**: `number`

Defined in: [src/interface/TimeSchedulingInterface.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/TimeSchedulingInterface.ts#L6)

The time when the item starts. If the item is not started yet, it will be hidden.
If you set 3, the item will be hidden into times 1 and 2, and will be shown from time 3.

***

### to? [#to]

\> `optional` **to?**: `number`

Defined in: [src/interface/TimeSchedulingInterface.ts:12](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/interface/TimeSchedulingInterface.ts#L12)

The time when the item ends. If the item is ended yet, it will be hidden.
If you set 3, the item will be shown into times 1 and 2 and will be hidden from time 3.

#### Default [#default]

```ts
timeTracker.dayEndTime + 1
```


# Function: add() (/nqtr/index/namespaces/RegisteredActivities/functions/add)



\> **add**(...`activities`): `void`

Defined in: [src/registries/RegisteredActivities.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredActivities.ts#L17)

Save an activity in the registered activities. If the activity already exists, it will be overwritten.

## Parameters [#parameters]

### activities [#activities]

...([`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface) | [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[])\[]

The activity to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredActivities/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredActivities.ts:67](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredActivities.ts#L67)

Remove all registered activities.
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredActivities/functions/get)



\> **get**(`id`): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface) | `undefined`

Defined in: [src/registries/RegisteredActivities.ts:32](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredActivities.ts#L32)

Get an activity by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the activity.

## Returns [#returns]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface) | `undefined`

The activity or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredActivities/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredActivities.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredActivities.ts#L59)

Check if an activity is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the activity.

## Returns [#returns]

`boolean`

True if the activity is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredActivities/functions/values)



\> **values**(): [`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

Defined in: [src/registries/RegisteredActivities.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredActivities.ts#L50)

Get a list of all activities registered.

## Returns [#returns]

[`ActivityInterface`](/nqtr/index/interfaces/ActivityInterface)\[]

An array of activities.


# RegisteredActivities (/nqtr/index/namespaces/RegisteredActivities)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredActivities/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredActivities/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredActivities/functions/get)
* [has](/nqtr/index/namespaces/RegisteredActivities/functions/has)
* [values](/nqtr/index/namespaces/RegisteredActivities/functions/values)


# Function: add() (/nqtr/index/namespaces/RegisteredCommitments/functions/add)



\> **add**(...`commitments`): `void`

Defined in: [src/registries/RegisteredCommitments.ts:27](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredCommitments.ts#L27)

Save a commitment in the registered commitments. If the commitment already exists, it will be overwritten.

## Parameters [#parameters]

### commitments [#commitments]

...([`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface) | [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[])\[]

The commitment to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredCommitments/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredCommitments.ts:74](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredCommitments.ts#L74)

Remove all registered commitments (both scheduled and fixed).
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredCommitments/functions/get)



\> **get**(`id`): [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface) | `undefined`

Defined in: [src/registries/RegisteredCommitments.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredCommitments.ts#L41)

Get a commitment by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the commitment.

## Returns [#returns]

[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface) | `undefined`

The commitment or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredCommitments/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredCommitments.ts:66](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredCommitments.ts#L66)

Check if a commitment is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the commitment.

## Returns [#returns]

`boolean`

True if the commitment is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredCommitments/functions/values)



\> **values**(): [`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

Defined in: [src/registries/RegisteredCommitments.ts:58](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredCommitments.ts#L58)

Get a list of all commitments registered.

## Returns [#returns]

[`CommitmentInterface`](/nqtr/index/interfaces/CommitmentInterface)\[]

An array of commitments.


# RegisteredCommitments (/nqtr/index/namespaces/RegisteredCommitments)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredCommitments/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredCommitments/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredCommitments/functions/get)
* [has](/nqtr/index/namespaces/RegisteredCommitments/functions/has)
* [values](/nqtr/index/namespaces/RegisteredCommitments/functions/values)


# Function: add() (/nqtr/index/namespaces/RegisteredLocations/functions/add)



\> **add**(...`locations`): `void`

Defined in: [src/registries/RegisteredLocations.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredLocations.ts#L17)

Save a location in the registered locations. If the location already exists, it will be overwritten.

## Parameters [#parameters]

### locations [#locations]

...([`LocationInterface`](/nqtr/index/interfaces/LocationInterface) | [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[])\[]

The location to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredLocations/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredLocations.ts:67](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredLocations.ts#L67)

Remove all registered locations.
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredLocations/functions/get)



\> **get**(`id`): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface) | `undefined`

Defined in: [src/registries/RegisteredLocations.ts:32](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredLocations.ts#L32)

Get a location by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the location.

## Returns [#returns]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface) | `undefined`

The location or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredLocations/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredLocations.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredLocations.ts#L59)

Check if a location is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the location.

## Returns [#returns]

`boolean`

True if the location is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredLocations/functions/values)



\> **values**(): [`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

Defined in: [src/registries/RegisteredLocations.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredLocations.ts#L50)

Get a list of all locations registered.

## Returns [#returns]

[`LocationInterface`](/nqtr/index/interfaces/LocationInterface)\[]

An array of locations.


# RegisteredLocations (/nqtr/index/namespaces/RegisteredLocations)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredLocations/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredLocations/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredLocations/functions/get)
* [has](/nqtr/index/namespaces/RegisteredLocations/functions/has)
* [values](/nqtr/index/namespaces/RegisteredLocations/functions/values)


# Function: add() (/nqtr/index/namespaces/RegisteredMaps/functions/add)



\> **add**(...`maps`): `void`

Defined in: [src/registries/RegisteredMaps.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredMaps.ts#L17)

Save a map in the registered maps. If the map already exists, it will be overwritten.

## Parameters [#parameters]

### maps [#maps]

...([`MapInterface`](/nqtr/index/interfaces/MapInterface) | [`MapInterface`](/nqtr/index/interfaces/MapInterface)\[])\[]

The map to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredMaps/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredMaps.ts:67](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredMaps.ts#L67)

Remove all registered maps.
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredMaps/functions/get)



\> **get**(`id`): [`MapInterface`](/nqtr/index/interfaces/MapInterface) | `undefined`

Defined in: [src/registries/RegisteredMaps.ts:32](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredMaps.ts#L32)

Get a map by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the map.

## Returns [#returns]

[`MapInterface`](/nqtr/index/interfaces/MapInterface) | `undefined`

The map or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredMaps/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredMaps.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredMaps.ts#L59)

Check if a map is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the map.

## Returns [#returns]

`boolean`

True if the map is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredMaps/functions/values)



\> **values**(): [`MapInterface`](/nqtr/index/interfaces/MapInterface)\[]

Defined in: [src/registries/RegisteredMaps.ts:50](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredMaps.ts#L50)

Get a list of all maps registered.

## Returns [#returns]

[`MapInterface`](/nqtr/index/interfaces/MapInterface)\[]

An array of maps.


# RegisteredMaps (/nqtr/index/namespaces/RegisteredMaps)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredMaps/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredMaps/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredMaps/functions/get)
* [has](/nqtr/index/namespaces/RegisteredMaps/functions/has)
* [values](/nqtr/index/namespaces/RegisteredMaps/functions/values)


# Function: add() (/nqtr/index/namespaces/RegisteredQuests/functions/add)



\> **add**(...`quests`): `void`

Defined in: [src/registries/RegisteredQuests.ts:17](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredQuests.ts#L17)

Save a quest in the registered quests. If the quest already exists, it will be overwritten.

## Parameters [#parameters]

### quests [#quests]

...([`QuestInterface`](/nqtr/index/interfaces/QuestInterface) | [`QuestInterface`](/nqtr/index/interfaces/QuestInterface)\[])\[]

The quest to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredQuests/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredQuests.ts:64](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredQuests.ts#L64)

Remove all registered quests.
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredQuests/functions/get)



\> **get**(`id`): [`QuestInterface`](/nqtr/index/interfaces/QuestInterface) | `undefined`

Defined in: [src/registries/RegisteredQuests.ts:31](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredQuests.ts#L31)

Get a quest by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the quest.

## Returns [#returns]

[`QuestInterface`](/nqtr/index/interfaces/QuestInterface) | `undefined`

The quest or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredQuests/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredQuests.ts:56](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredQuests.ts#L56)

Check if a quest is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the quest.

## Returns [#returns]

`boolean`

True if the quest is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredQuests/functions/values)



\> **values**(): [`QuestInterface`](/nqtr/index/interfaces/QuestInterface)\[]

Defined in: [src/registries/RegisteredQuests.ts:48](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredQuests.ts#L48)

Get a list of all quests registered.

## Returns [#returns]

[`QuestInterface`](/nqtr/index/interfaces/QuestInterface)\[]

An array of quests.


# RegisteredQuests (/nqtr/index/namespaces/RegisteredQuests)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredQuests/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredQuests/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredQuests/functions/get)
* [has](/nqtr/index/namespaces/RegisteredQuests/functions/has)
* [values](/nqtr/index/namespaces/RegisteredQuests/functions/values)


# Function: add() (/nqtr/index/namespaces/RegisteredRooms/functions/add)



\> **add**(...`rooms`): `void`

Defined in: [src/registries/RegisteredRooms.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredRooms.ts#L20)

Save a room in the registered rooms, and their location and map if they are not already registered.
If the room already exists, it will be overwritten.

## Parameters [#parameters]

### rooms [#rooms]

...([`RoomInterface`](/nqtr/index/interfaces/RoomInterface) | [`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[])\[]

The room to save.

## Returns [#returns]

`void`


# Function: clear() (/nqtr/index/namespaces/RegisteredRooms/functions/clear)



\> **clear**(): `void`

Defined in: [src/registries/RegisteredRooms.ts:76](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredRooms.ts#L76)

Remove all registered rooms.
Primarily used by the Vite plugin to reset state between hot-module reloads.

## Returns [#returns]

`void`


# Function: get() (/nqtr/index/namespaces/RegisteredRooms/functions/get)



\> **get**(`id`): [`RoomInterface`](/nqtr/index/interfaces/RoomInterface) | `undefined`

Defined in: [src/registries/RegisteredRooms.ts:41](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredRooms.ts#L41)

Get a room by its id.

## Parameters [#parameters]

### id [#id]

`string`

The id of the room.

## Returns [#returns]

[`RoomInterface`](/nqtr/index/interfaces/RoomInterface) | `undefined`

The room or undefined if not found.


# Function: has() (/nqtr/index/namespaces/RegisteredRooms/functions/has)



\> **has**(`id`): `boolean`

Defined in: [src/registries/RegisteredRooms.ts:68](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredRooms.ts#L68)

Check if a room is registered.

## Parameters [#parameters]

### id [#id]

`string`

The id of the room.

## Returns [#returns]

`boolean`

True if the room is registered, false otherwise.


# Function: values() (/nqtr/index/namespaces/RegisteredRooms/functions/values)



\> **values**(): [`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

Defined in: [src/registries/RegisteredRooms.ts:59](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/RegisteredRooms.ts#L59)

Get a list of all rooms registered.

## Returns [#returns]

[`RoomInterface`](/nqtr/index/interfaces/RoomInterface)\[]

An array of rooms.


# RegisteredRooms (/nqtr/index/namespaces/RegisteredRooms)



## Functions [#functions]

* [add](/nqtr/index/namespaces/RegisteredRooms/functions/add)
* [clear](/nqtr/index/namespaces/RegisteredRooms/functions/clear)
* [get](/nqtr/index/namespaces/RegisteredRooms/functions/get)
* [has](/nqtr/index/namespaces/RegisteredRooms/functions/has)
* [values](/nqtr/index/namespaces/RegisteredRooms/functions/values)


# Type Alias: ActivityIdType (/nqtr/index/type-aliases/ActivityIdType)



\> **ActivityIdType** = \[keyof [`NqtrActivityIds`](/nqtr/index/interfaces/NqtrActivityIds)] *extends* \[`never`] ? `string` : keyof [`NqtrActivityIds`](/nqtr/index/interfaces/NqtrActivityIds)

Defined in: [src/registries/NqtrIds.ts:40](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L40)

The type used wherever an activity ID is expected.

* **Default** — resolves to `string` so that existing code compiles without changes.
* **Augmented** — when [NqtrActivityIds](/nqtr/index/interfaces/NqtrActivityIds) has been extended via
  `declare module "@drincs/nqtr/registries"`, resolves to the union of known activity IDs.

## Example [#example]

```ts
// nqtr.gen.d.ts (auto-generated by vitePluginNqtr)
declare module "@drincs/nqtr/registries" {
    interface NqtrActivityIds { "study": never; "cook": never; }
}
```


# Type Alias: CommitmentIdType (/nqtr/index/type-aliases/CommitmentIdType)



\> **CommitmentIdType** = \[keyof [`NqtrCommitmentIds`](/nqtr/index/interfaces/NqtrCommitmentIds)] *extends* \[`never`] ? `string` : keyof [`NqtrCommitmentIds`](/nqtr/index/interfaces/NqtrCommitmentIds)

Defined in: [src/registries/NqtrIds.ts:51](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L51)

The type used wherever a commitment ID is expected.

* **Default** — resolves to `string`.
* **Augmented** — resolves to the union of known commitment IDs once
  [NqtrCommitmentIds](/nqtr/index/interfaces/NqtrCommitmentIds) has been extended.


# Type Alias: ExecutionType (/nqtr/index/type-aliases/ExecutionType)



\> **ExecutionType** = `"automatic"` | `"interaction"`

Defined in: [src/types/ExecutionType.ts:1](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/ExecutionType.ts#L1)


# Type Alias: ITimeStlot (/nqtr/index/type-aliases/ITimeStlot)



\> **ITimeStlot** = `object`

Defined in: [src/types/TimeSettings.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L3)

## Properties [#properties]

### name [#name]

\> **name**: `string`

Defined in: [src/types/TimeSettings.ts:4](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L4)

***

### startTime [#starttime]

\> **startTime**: `number`

Defined in: [src/types/TimeSettings.ts:5](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L5)


# Type Alias: LocationIdType (/nqtr/index/type-aliases/LocationIdType)



\> **LocationIdType** = \[keyof [`NqtrLocationIds`](/nqtr/index/interfaces/NqtrLocationIds)] *extends* \[`never`] ? `string` : keyof [`NqtrLocationIds`](/nqtr/index/interfaces/NqtrLocationIds)

Defined in: [src/registries/NqtrIds.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L62)

The type used wherever a location ID is expected.

* **Default** — resolves to `string`.
* **Augmented** — resolves to the union of known location IDs once
  [NqtrLocationIds](/nqtr/index/interfaces/NqtrLocationIds) has been extended.


# Type Alias: MapIdType (/nqtr/index/type-aliases/MapIdType)



\> **MapIdType** = \[keyof [`NqtrMapIds`](/nqtr/index/interfaces/NqtrMapIds)] *extends* \[`never`] ? `string` : keyof [`NqtrMapIds`](/nqtr/index/interfaces/NqtrMapIds)

Defined in: [src/registries/NqtrIds.ts:73](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L73)

The type used wherever a map ID is expected.

* **Default** — resolves to `string`.
* **Augmented** — resolves to the union of known map IDs once
  [NqtrMapIds](/nqtr/index/interfaces/NqtrMapIds) has been extended.


# Type Alias: OnRunAsyncFunction (/nqtr/index/type-aliases/OnRunAsyncFunction)



\> **OnRunAsyncFunction** = (`props`) => `Promise`\<`any`>

Defined in: [src/types/OnRunEvent.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/OnRunEvent.ts#L8)

## Parameters [#parameters]

### props [#props]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

## Returns [#returns]

`Promise`\<`any`>


# Type Alias: OnRunEvent<T> (/nqtr/index/type-aliases/OnRunEvent)



\> **OnRunEvent**\<`T`> = (`item`, `props`) => `any` | `Promise`\<`any`>

Defined in: [src/types/OnRunEvent.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/OnRunEvent.ts#L6)

The function that is called when the class is runned.

## Type Parameters [#type-parameters]

### T [#t]

`T`

## Parameters [#parameters]

### item [#item]

`T`

### props [#props]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

## Returns [#returns]

`any` | `Promise`\<`any`>


# Type Alias: OnRunFunction (/nqtr/index/type-aliases/OnRunFunction)



\> **OnRunFunction** = (`props`) => `any` | `Promise`\<`any`>

Defined in: [src/types/OnRunEvent.ts:7](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/OnRunEvent.ts#L7)

## Parameters [#parameters]

### props [#props]

[`OnRunProps`](/nqtr/index/interfaces/OnRunProps)

## Returns [#returns]

`any` | `Promise`\<`any`>


# Type Alias: QuestIdType (/nqtr/index/type-aliases/QuestIdType)



\> **QuestIdType** = \[keyof [`NqtrQuestIds`](/nqtr/index/interfaces/NqtrQuestIds)] *extends* \[`never`] ? `string` : keyof [`NqtrQuestIds`](/nqtr/index/interfaces/NqtrQuestIds)

Defined in: [src/registries/NqtrIds.ts:82](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L82)

The type used wherever a quest ID is expected.

* **Default** — resolves to `string`.
* **Augmented** — resolves to the union of known quest IDs once
  [NqtrQuestIds](/nqtr/index/interfaces/NqtrQuestIds) has been extended.


# Type Alias: QuestsRequiredType (/nqtr/index/type-aliases/QuestsRequiredType)



\> **QuestsRequiredType** = `object`

Defined in: [src/types/QuestsRequired.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/QuestsRequired.ts#L3)

## Properties [#properties]

### quest [#quest]

\> **quest**: [`QuestInterface`](/nqtr/index/interfaces/QuestInterface)

Defined in: [src/types/QuestsRequired.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/QuestsRequired.ts#L3)

***

### stageNumber [#stagenumber]

\> **stageNumber**: `number`

Defined in: [src/types/QuestsRequired.ts:3](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/QuestsRequired.ts#L3)


# Type Alias: RoomIdType (/nqtr/index/type-aliases/RoomIdType)



\> **RoomIdType** = \[keyof [`NqtrRoomIds`](/nqtr/index/interfaces/NqtrRoomIds)] *extends* \[`never`] ? `string` : keyof [`NqtrRoomIds`](/nqtr/index/interfaces/NqtrRoomIds)

Defined in: [src/registries/NqtrIds.ts:99](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/registries/NqtrIds.ts#L99)

The type used wherever a room ID is expected.

* **Default** — resolves to `string`.
* **Augmented** — resolves to the union of known room IDs once
  [NqtrRoomIds](/nqtr/index/interfaces/NqtrRoomIds) has been extended.

## Example [#example]

```ts
import type { RoomIdType } from "@drincs/nqtr/registries";

function navigateTo(roomId: RoomIdType) { ... }
navigateTo("bedroom"); // ✅ compile error if "bedroom" is not a known room
```


# Type Alias: TimeSettings (/nqtr/index/type-aliases/TimeSettings)



\> **TimeSettings** = `object`

Defined in: [src/types/TimeSettings.ts:11](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L11)

Time Settings, which can be set using timeTracker.editSettings

## Properties [#properties]

### dayEndTime? [#dayendtime]

\> `optional` **dayEndTime?**: `number`

Defined in: [src/types/TimeSettings.ts:21](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L21)

Maximum time of the day

#### Default [#default]

```ts
24
```

***

### dayStartTime? [#daystarttime]

\> `optional` **dayStartTime?**: `number`

Defined in: [src/types/TimeSettings.ts:16](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L16)

Minimum time of the day

#### Default [#default-1]

```ts
0
```

***

### defaultTimeSpent? [#defaulttimespent]

\> `optional` **defaultTimeSpent?**: `number`

Defined in: [src/types/TimeSettings.ts:26](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L26)

Default time spent

#### Default [#default-2]

```ts
1
```

***

### getDayName? [#getdayname]

\> `optional` **getDayName?**: (`weekDayNumber`) => `string`

Defined in: [src/types/TimeSettings.ts:62](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L62)

Week days name

#### Parameters [#parameters]

##### weekDayNumber [#weekdaynumber]

`number`

The current week day number (from: 0 - to: [weekLength](#weeklength) - 1).

#### Returns [#returns]

`string`

The name of the week day.

#### Example [#example]

```ts
(weekDayNumber: number) => {
    const weekDaysNames = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'];
    return weekDaysNames[weekDayNumber];
}
```

***

### timeSlots? [#timeslots]

\> `optional` **timeSlots?**: [`ITimeStlot`](/nqtr/index/type-aliases/ITimeStlot)\[]

Defined in: [src/types/TimeSettings.ts:39](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L39)

Time slots

#### Default [#default-3]

```ts
[]
```

#### Example [#example-1]

````ts
[
  { name: 'Morning', startTime: 5 },
  { name: 'Afternoon', startTime: 12 },
  { name: 'Evening', startTime: 18 },
  { name: 'Night', startTime: 22 }
]

***

### weekendStartDay?

> `optional` **weekendStartDay?**: `number`

Defined in: [src/types/TimeSettings.ts:49](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L49)

Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6

#### Default

```ts
weekLength - 1
````

***

### weekLength? [#weeklength]

> `optional` **weekLength?**: `number`

Defined in: [src/types/TimeSettings.ts:44](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/types/TimeSettings.ts#L44)

Week length

#### Default [#default-4]

```ts
7
```


# Variable: default (/nqtr/index/variables/default)



\> `const` **default**: `object`

Defined in: [src/index.ts:20](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/index.ts#L20)

## Type Declaration [#type-declaration]

### handlers [#handlers]

\> **handlers**: `__module`

### registries [#registries]

\> **registries**: `__module`

### ActivityBaseModel [#activitybasemodel]

Re-exports [ActivityBaseModel](/nqtr/index/classes/ActivityBaseModel)

### ActivityStoredClass [#activitystoredclass]

Re-exports [ActivityStoredClass](/nqtr/index/classes/ActivityStoredClass)

### CommitmentBaseModel [#commitmentbasemodel]

Re-exports [CommitmentBaseModel](/nqtr/index/classes/CommitmentBaseModel)

### CommitmentStoredClass [#commitmentstoredclass]

Re-exports [CommitmentStoredClass](/nqtr/index/classes/CommitmentStoredClass)

### LocationBaseModel [#locationbasemodel]

Re-exports [LocationBaseModel](/nqtr/index/classes/LocationBaseModel)

### LocationStoredClass [#locationstoredclass]

Re-exports [LocationStoredClass](/nqtr/index/classes/LocationStoredClass)

### MapBaseModel [#mapbasemodel]

Re-exports [MapBaseModel](/nqtr/index/classes/MapBaseModel)

### MapStoredClass [#mapstoredclass]

Re-exports [MapStoredClass](/nqtr/index/classes/MapStoredClass)

### QuestBaseModel [#questbasemodel]

Re-exports [QuestBaseModel](/nqtr/index/classes/QuestBaseModel)

### QuestStoredClass [#queststoredclass]

Re-exports [QuestStoredClass](/nqtr/index/classes/QuestStoredClass)

### RoomBaseModel [#roombasemodel]

Re-exports [RoomBaseModel](/nqtr/index/classes/RoomBaseModel)

### RoomStoredClass [#roomstoredclass]

Re-exports [RoomStoredClass](/nqtr/index/classes/RoomStoredClass)

### StageBaseModel [#stagebasemodel]

Re-exports [StageBaseModel](/nqtr/index/classes/StageBaseModel)

### StageStoredClass [#stagestoredclass]

Re-exports [StageStoredClass](/nqtr/index/classes/StageStoredClass)


# Variable: navigator (/nqtr/index/variables/navigator)



\> `const` **navigator**: `NavigatorHandler`

Defined in: [src/handlers/index.ts:7](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/handlers/index.ts#L7)


# Variable: questsNotebook (/nqtr/index/variables/questsNotebook)



\> `const` **questsNotebook**: `QuestHandler`

Defined in: [src/handlers/index.ts:9](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/handlers/index.ts#L9)


# Variable: routine (/nqtr/index/variables/routine)



\> `const` **routine**: `RoutineHandler`

Defined in: [src/handlers/index.ts:8](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/handlers/index.ts#L8)


# Variable: timeTracker (/nqtr/index/variables/timeTracker)



\> `const` **timeTracker**: `TimeHandler`

Defined in: [src/handlers/index.ts:6](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/handlers/index.ts#L6)


# Function: createNqtrHandler() (/nqtr/ink/functions/createNqtrHandler)



\> **createNqtrHandler**(`options?`): `void`

Defined in: [src/ink/nqtrHandler.ts:88](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/ink/nqtrHandler.ts#L88)

Registers all NQTR-specific Ink hashtag command handlers for managing rooms, time, date,
activities, routines, and quests. Supports commands like `enter room`, `set time`, `set date`,
`add/remove activity`, `add/remove routine`, `start/continue quest`, and `wait`.

## Parameters [#parameters]

### options? [#options]

`NqtrHandlerOptions` = `{}`

Optional configuration for time/date conversion, wait logic, and known entity IDs.

## Returns [#returns]

`void`

## Example [#example]

```ts
import { createNqtrHandler } from '@drincs/nqtr/ink';

createNqtrHandler();
```


# Function: nqtrHandler() (deprecated) (/nqtr/ink/functions/nqtrHandler)



\> **nqtrHandler**(`options?`): `void`

Defined in: [src/ink/nqtrHandler.ts:477](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/ink/nqtrHandler.ts#L477)

## Parameters [#parameters]

### options? [#options]

`NqtrHandlerOptions`

## Returns [#returns]

`void`

## Deprecated [#deprecated]

Use [createNqtrHandler](/nqtr/ink/functions/createNqtrHandler) instead.


# ink (/nqtr/ink)



## Functions [#functions]

* [createNqtrHandler](/nqtr/ink/functions/createNqtrHandler)
* [~~nqtrHandler~~](/nqtr/ink/functions/nqtrHandler)


# @drincs/nqtr (/nqtr/modules)



## Modules [#modules]

* [index](/nqtr/index)
* [ink](/nqtr/ink)
* [vite](/nqtr/vite)


# Function: vitePluginNqtr() (/nqtr/vite/functions/vitePluginNqtr)



\> **vitePluginNqtr**(`options?`): `Plugin`

Defined in: [src/vite/index.ts:222](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L222)

Creates a Vite plugin that generates TypeScript declaration files with
compile-time–safe ID types for all six NQTR entity registries:
activities, commitments, locations, maps, quests, and rooms.

***

**How it works**

At startup (and after every hot-module reload), the plugin executes the
content modules listed in the options server-side via Vite SSR.  Those
modules register entities by calling `RegisteredActivities.add(...)`,
`RegisteredRooms.add(...)`, etc.  The plugin then reads back the IDs from
all six registries and writes a `.d.ts` declaration file that augments the
`Nqtr*Ids` interfaces in `@drincs/nqtr/registries`.

***

**Pixi-VN integration**

If `vitePluginPixivn` (from `@drincs/pixi-vn/vite`) is present in the same
Vite config, this plugin automatically waits for its `contentLoaded`
signal before reading registry state.  This means you can pass a single
`content` barrel file to `vitePluginPixivn` and have both plugins read from
it without duplicating the option:

```ts
// vite.config.ts
import { vitePluginPixivn } from "@drincs/pixi-vn/vite";
import { vitePluginNqtr } from "@drincs/nqtr/vite";

export default defineConfig({
  plugins: [
    vitePluginPixivn({ content: "./src/content/index.ts" }),
    vitePluginNqtr({ typeFilePath: "./src/nqtr.keys.gen.ts" }),
  ],
});
```

The nqtr plugin will piggy-back on pixi-vn's content loading and re-run
type generation on every hot-reload triggered by the pixi-vn plugin.

***

**Standalone usage** (without pixi-vn)

Target specific entity files directly:

```ts
vitePluginNqtr({
  activities:   "./src/activities/*.ts",
  rooms:        "./src/rooms.ts",
  locations:    "./src/locations.ts",
  maps:         "./src/maps.ts",
  typeFilePath: "./src/nqtr.keys.gen.ts",
})
```

***

**Generated file**

The file written to [VitePluginNqtrOptions.typeFilePath](/nqtr/vite/interfaces/VitePluginNqtrOptions#typefilepath) looks like:

```ts
// nqtr.keys.gen.ts  — auto-generated, do not edit manually
export const nqtrActivityIds = ["study", "cook"] as const;
export const nqtrRoomIds = ["bedroom", "kitchen"] as const;
// …

declare module "@drincs/nqtr/registries" {
    interface NqtrActivityIds { "study": never; "cook": never; }
    interface NqtrRoomIds     { "bedroom": never; "kitchen": never; }
    // …
}
```

The `as const` arrays can be passed to createNqtrHandler for runtime
validation of Ink hashtag commands. The `declare module` augmentation narrows
the `*IdType` helpers (`ActivityIdType`, `RoomIdType`, …) from `string` to
the union of known literal IDs at compile time.

## Parameters [#parameters]

### options? [#options]

[`VitePluginNqtrOptions`](/nqtr/vite/interfaces/VitePluginNqtrOptions)

Optional plugin configuration.

## Returns [#returns]

`Plugin`

A Vite plugin.


# vite (/nqtr/vite)



## Interfaces [#interfaces]

* [VitePluginNqtrOptions](/nqtr/vite/interfaces/VitePluginNqtrOptions)

## Functions [#functions]

* [vitePluginNqtr](/nqtr/vite/functions/vitePluginNqtr)


# Interface: VitePluginNqtrOptions (/nqtr/vite/interfaces/VitePluginNqtrOptions)



Defined in: [src/vite/index.ts:61](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L61)

Options for [vitePluginNqtr](/nqtr/vite/functions/vitePluginNqtr).

## Properties [#properties]

### activities? [#activities]

\> `optional` **activities?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L69)

Glob / path of module(s) whose side effects register activities via
`RegisteredActivities.add(...)`.

#### Examples [#examples]

```ts
"./src/activities.ts"
```

```ts
"./src/activities/*.ts"
```

***

### commitments? [#commitments]

\> `optional` **commitments?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:77](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L77)

Glob / path of module(s) whose side effects register commitments via
`RegisteredCommitments.add(...)`.

#### Example [#example]

```ts
"./src/commitments.ts"
```

***

### locations? [#locations]

\> `optional` **locations?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:85](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L85)

Glob / path of module(s) whose side effects register locations via
`RegisteredLocations.add(...)`.

#### Example [#example-1]

```ts
"./src/locations.ts"
```

***

### maps? [#maps]

\> `optional` **maps?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:93](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L93)

Glob / path of module(s) whose side effects register maps via
`RegisteredMaps.add(...)`.

#### Example [#example-2]

```ts
"./src/maps.ts"
```

***

### quests? [#quests]

\> `optional` **quests?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:102](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L102)

Glob / path of module(s) whose side effects register quests via
`RegisteredQuests.add(...)`.

#### Examples [#examples-1]

```ts
"./src/quests.ts"
```

```ts
"./src/*.quest.ts"
```

***

### rooms? [#rooms]

\> `optional` **rooms?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:110](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L110)

Glob / path of module(s) whose side effects register rooms via
`RegisteredRooms.add(...)`.

#### Example [#example-3]

```ts
"./src/rooms.ts"
```

***

### typeFilePath? [#typefilepath]

\> `optional` **typeFilePath?**: `string`

Defined in: [src/vite/index.ts:132](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L132)

Path to the auto-generated TypeScript file that contains both:

* `as const` runtime arrays of all currently known entity IDs
  (e.g. `nqtrActivityIds`, `nqtrRoomIds`, …) — import these into
  createNqtrHandler for runtime validation of Ink hashtag commands.
* a `declare module` augmentation of the six `Nqtr*Ids` interfaces in
  `@drincs/nqtr/registries` — gives compile-time–safe ID types once the
  file is included in the project's TypeScript compilation.

When provided, the plugin generates (or overwrites) this file:

* after all content modules have been loaded at startup,
* after every hot-reload of a watched content file.

The generated file is **excluded from HMR** so that regenerating it
never triggers a full-page reload.

The path may be absolute or relative to Vite `root`.

#### Example [#example-4]

```ts
"./src/nqtr.keys.gen.ts"
```


# Spine 2D integration for Pixi’VN (/pixi-vn-spine)



![pixi-vn-cover](https://github.com/user-attachments/assets/6d0edd5e-4ff6-414b-9c27-348e70f866b1)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-spine" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn-spine?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-spine" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/pixi-vn-spine" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/pixi-vn-spine" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/pixi-vn-spine?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-spine" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/pixi-vn-spine" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

`@drincs/pixi-vn-spine` is a lightweight wrapper around `@esotericsoftware/spine-pixi-v8`, designed specifically to integrate **Spine 2D** components into **Pixi’VN** projects.

The library provides Pixi’VN-friendly abstractions for using Spine animations inside visual novels, making it easier to load, manage, and display Spine content within the Pixi’VN ecosystem.

## Example [#example]

```ts
import { Assets, canvas } from "@drincs/pixi-vn";
import { Spine } from "@drincs/pixi-vn-spine";

await Assets.load([
    {
        alias: "spineSkeleton",
        src: "https://raw.githubusercontent.com/pixijs/spine-v8/main/examples/assets/spineboy-pro.skel",
    },
    {
        alias: "spineAtlas",
        src: "https://raw.githubusercontent.com/pixijs/spine-v8/main/examples/assets/spineboy-pma.atlas",
    },
]);

const spine = new Spine({ atlas: "spineAtlas", skeleton: "spineSkeleton" });
spine.x = canvas.width / 2;
spine.y = canvas.height;

spine.setAnimation(0, "idle", true);

canvas.add("spine", spine);
```

## Important: register the component in your main file [#important-register-the-component-in-your-main-file]

When this package is imported, it registers `Spine` with Pixi’VN's `RegisteredCanvasComponents`, which is what allows the canvas to restore a `Spine` instance from a serialized save (e.g. `currentSkin`, animation tracks, etc.). This registration is a side effect that runs the first time the module is evaluated, not when `Spine` is actually used.

In simple setups this isn't noticeable, because importing `Spine` to create an instance also triggers the registration. But in more complex projects with asynchronous/lazy loading (code-split routes, dynamically imported labels, a save loaded before any scene that uses `Spine` has been imported, etc.), the registration might not have happened yet when Pixi’VN needs to deserialize a save containing a `Spine` component — restoring it will then fail because `"Spine"` isn't registered.

To avoid this, import the package once, for its side effect only, directly in your app's main/entry file, before anything else runs:

```ts
import "@drincs/pixi-vn-spine";
```

This guarantees the registration always happens as early as possible, regardless of when/where `Spine` is later imported and used.


# Class: Spine (/pixi-vn-spine/index/classes/Spine)



Defined in: [src/components/Spine.ts:57](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L57)

Spine component for Pixi.js, used to display Spine components.

## Example [#example]

```ts
import { Assets, canvas } from "@drincs/pixi-vn";
import { Spine } from "@drincs/pixi-vn-spine";

await Assets.load([
    {
        alias: "spineSkeleton",
        src: "https://raw.githubusercontent.com/pixijs/spine-v8/main/examples/assets/spineboy-pro.skel",
    },
    {
        alias: "spineAtlas",
        src: "https://raw.githubusercontent.com/pixijs/spine-v8/main/examples/assets/spineboy-pma.atlas",
    },
]);

const spine = new Spine({ atlas: "spineAtlas", skeleton: "spineSkeleton" });
spine.x = canvas.width / 2;
spine.y = canvas.height;

canvas.add("spine", spine);
```

## Extends [#extends]

* `Spine`

## Implements [#implements]

* `CanvasBaseItem`\<[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory)>
* `AnchorExtension`
* `ListenerExtension`
* `AdditionalPositionsExtension`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Spine**(`options`): `Spine`

Defined in: [src/components/Spine.ts:69](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L69)

#### Parameters [#parameters]

##### options [#options]

[`SpineOptions`](/pixi-vn-spine/index/interfaces/SpineOptions)

Options used to configure the Spine skeleton (skeleton/atlas aliases, scale, dark tint, auto update, initial skin, initial animation)
plus the standard CanvasBaseItem container options (anchor, align, percentagePosition, etc.).

#### Returns [#returns]

`Spine`

#### Overrides [#overrides]

`CoreSpine.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

`CoreSpine.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

`CoreSpine.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

`CoreSpine.__devtoolLocked`

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

#### Inherited from [#inherited-from-3]

`CoreSpine._bounds`

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

#### Inherited from [#inherited-from-4]

`CoreSpine._boundsDirty`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-5]

`CoreSpine._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-6]

`CoreSpine._cy`

***

### \_didSpineUpdate [#_didspineupdate]

\> **\_didSpineUpdate**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:174

#### Inherited from [#inherited-from-7]

`CoreSpine._didSpineUpdate`

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

#### Inherited from [#inherited-from-8]

`CoreSpine._gcData`

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

#### Inherited from [#inherited-from-9]

`CoreSpine._gcLastUsed`

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

#### Inherited from [#inherited-from-10]

`CoreSpine._gpuData`

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

#### Inherited from [#inherited-from-11]

`CoreSpine._lastUsed`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-12]

`CoreSpine._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-13]

`CoreSpine._position`

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

#### Inherited from [#inherited-from-14]

`CoreSpine._roundPixels`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-15]

`CoreSpine._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-16]

`CoreSpine._skew`

***

### \_slotsObject [#_slotsobject]

\> `readonly` **\_slotsObject**: `Record`\<`string`, `SpineSlotObject` | `null`>

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:184

#### Inherited from [#inherited-from-17]

`CoreSpine._slotsObject`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-18]

`CoreSpine._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-19]

`CoreSpine._sy`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-20]

`CoreSpine._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-21]

`CoreSpine.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-22]

`CoreSpine.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-23]

`CoreSpine.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-24]

`CoreSpine.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-25]

`CoreSpine.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-26]

`CoreSpine.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-27]

`CoreSpine.accessibleType`

***

### afterUpdateWorldTransforms [#afterupdateworldtransforms]

\> **afterUpdateWorldTransforms**: (`object`) => `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:176

#### Parameters [#parameters-1]

##### object [#object]

`Spine`

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-28]

`CoreSpine.afterUpdateWorldTransforms`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

#### Inherited from [#inherited-from-29]

`CoreSpine.allowChildren`

***

### atlasAlias [#atlasalias]

\> `readonly` **atlasAlias**: `string`

Defined in: [src/components/Spine.ts:118](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L118)

The asset alias of the atlas this component was created with.

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-30]

`CoreSpine.autoGarbageCollect`

***

### beforeUpdateWorldTransforms [#beforeupdateworldtransforms]

\> **beforeUpdateWorldTransforms**: (`object`) => `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:175

#### Parameters [#parameters-2]

##### object [#object-1]

`Spine`

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-31]

`CoreSpine.beforeUpdateWorldTransforms`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-32]

`CoreSpine.boundsArea`

***

### buildId [#buildid]

\> **buildId**: `number`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:172

#### Inherited from [#inherited-from-33]

`CoreSpine.buildId`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-34]

`CoreSpine.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-3]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-3]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* Container#updateCacheTexture For updating cached content
* [Container#isCachedAsTexture](#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-35]

`CoreSpine.cacheAsTexture`

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

#### Inherited from [#inherited-from-36]

`CoreSpine.canBundle`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-37]

`CoreSpine.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-38]

`CoreSpine.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-39]

`CoreSpine.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-40]

`CoreSpine.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-41]

`CoreSpine.cursor`

***

### darkTintCore [#darktintcore]

\> `readonly` **darkTintCore**: `boolean` | `undefined`

Defined in: [src/components/Spine.ts:124](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L124)

Whether the dark tint renderer is used for this skeleton. If `true`, uses the dark tint renderer; if
`false`, uses the default pixi renderer; if `undefined`, the dark tint renderer is used only when at
least one slot has tint black.

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-42]

`CoreSpine.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

Container#destroy For destroying objects

#### Inherited from [#inherited-from-43]

`CoreSpine.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-44]

`CoreSpine.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-45]

`CoreSpine.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* Container#filters For applying filters
* Rectangle For area definition

#### Inherited from [#inherited-from-46]

`CoreSpine.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-47]

`CoreSpine.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-48]

`CoreSpine.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-49]

`CoreSpine.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-50]

`CoreSpine.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-51]

`CoreSpine.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-52]

`CoreSpine.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-53]

`CoreSpine.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-54]

`CoreSpine.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-55]

`CoreSpine.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* Container#cacheAsTexture For enabling caching
* Container#updateCacheTexture For updating cache

#### Inherited from [#inherited-from-56]

`CoreSpine.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-5]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-57]

`CoreSpine.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-58]

`CoreSpine.label`

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-59]

`CoreSpine.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-60]

`CoreSpine.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-61]

`CoreSpine.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-62]

`CoreSpine.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-63]

`CoreSpine.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* Container#worldTransform For global transform
* Container#groupTransform For render group transform

#### Inherited from [#inherited-from-64]

`CoreSpine.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-65]

`CoreSpine.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-66]

`CoreSpine.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-67]

`CoreSpine.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: `OnEventsHandlers` = `{}`

Defined in: [src/components/Spine.ts:459](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L459)

The registered event handlers for this component, used by [setMemory](#setmemory)/[memory](#memory) to
persist and restore listeners added via [on](#on).

#### Implementation of [#implementation-of]

`ListenerExtension.onEventsHandlers`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-68]

`CoreSpine.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-69]

`CoreSpine.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-70]

`CoreSpine.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-71]

`CoreSpine.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-72]

`CoreSpine.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-73]

`CoreSpine.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-74]

`CoreSpine.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-75]

`CoreSpine.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-76]

`CoreSpine.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-77]

`CoreSpine.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-78]

`CoreSpine.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-79]

`CoreSpine.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-80]

`CoreSpine.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-81]

`CoreSpine.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-82]

`CoreSpine.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-83]

`CoreSpine.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-84]

`CoreSpine.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-85]

`CoreSpine.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-86]

`CoreSpine.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-87]

`CoreSpine.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-88]

`CoreSpine.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-89]

`CoreSpine.onRender`

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-90]

`CoreSpine.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-91]

`CoreSpine.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-92]

`CoreSpine.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-93]

`CoreSpine.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-94]

`CoreSpine.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-95]

`CoreSpine.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-96]

`CoreSpine.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-97]

`CoreSpine.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-98]

`CoreSpine.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-99]

`CoreSpine.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-100]

`CoreSpine.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-101]

`CoreSpine.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-102]

`CoreSpine.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_SPINE_ID`

Defined in: [src/components/Spine.ts:114](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L114)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Implementation of [#implementation-of-1]

`CanvasBaseItem.pixivnId`

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-103]

`CoreSpine.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `"spine"` = `"spine"`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:173

**`Internal`**

#### Inherited from [#inherited-from-104]

`CoreSpine.renderPipeId`

***

### skeleton [#skeleton]

\> **skeleton**: `Skeleton`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:178

The skeleton for this Spine game object.

#### Inherited from [#inherited-from-105]

`CoreSpine.skeleton`

***

### skeletonAlias [#skeletonalias]

\> `readonly` **skeletonAlias**: `string`

Defined in: [src/components/Spine.ts:116](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L116)

The asset alias of the skeleton this component was created with.

***

### skeletonBounds? [#skeletonbounds]

\> `optional` **skeletonBounds?**: `SkeletonBounds`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:181

#### Inherited from [#inherited-from-106]

`CoreSpine.skeletonBounds`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-107]

`CoreSpine.sortableChildren`

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-6]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](#sortablechildren) For enabling automatic sorting
* [Container#zIndex](#zindex) For setting child order

#### Inherited from [#inherited-from-108]

`CoreSpine.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-109]

`CoreSpine.sortDirty`

***

### spineAttachmentsDirty [#spineattachmentsdirty]

\> **spineAttachmentsDirty**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:187

#### Inherited from [#inherited-from-110]

`CoreSpine.spineAttachmentsDirty`

***

### spineTexturesDirty [#spinetexturesdirty]

\> **spineTexturesDirty**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:188

#### Inherited from [#inherited-from-111]

`CoreSpine.spineTexturesDirty`

***

### state [#state]

\> **state**: `AnimationState`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:180

The animation state for this Spine game object.

#### Inherited from [#inherited-from-112]

`CoreSpine.state`

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-113]

`CoreSpine.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-114]

`CoreSpine.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-7]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-115]

`CoreSpine.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-116]

`CoreSpine.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-117]

`CoreSpine.zIndex`

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-118]

`CoreSpine.prefixed`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/components/Spine.ts:527](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L527)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-8]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/components/Spine.ts:515](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L515)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-4]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-9]

`void`

#### Implementation of [#implementation-of-2]

`AdditionalPositionsExtension.align`

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* Container#visible For toggling visibility
* Container#renderable For render control

##### Returns [#returns-10]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-5]

###### value [#value-1]

`number`

##### Returns [#returns-11]

`void`

#### Inherited from [#inherited-from-119]

`CoreSpine.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `PointData`

Defined in: [src/components/Spine.ts:487](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L487)

The anchor sets the origin point of the imageContainer. The default value is taken from the Texture
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-66]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Returns [#returns-12]

`PointData`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: [src/components/Spine.ts:492](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L492)

The anchor sets the origin point of the imageContainer. The default value is taken from the Texture
and passed to the constructor.

The default is `(0,0)`, this means the imageContainer's origin is the top left.

Setting the anchor to `(0.5,0.5)` means the imageContainer's origin is centered.

Setting the anchor to `(1,1)` would mean the imageContainer's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-67]

```ts
import { ImageContainer } from '@drincs/pixi-vn';

const imageContainer = new ImageContainer();
imageContainer.anchor = 0.5;
```

##### Parameters [#parameters-6]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-13]

`void`

#### Implementation of [#implementation-of-3]

`AnchorExtension.anchor`

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-68]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-14]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-7]

###### value [#value-3]

`number`

##### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-120]

`CoreSpine.angle`

***

### autoUpdate [#autoupdate]

#### Get Signature [#get-signature-4]

\> **get** **autoUpdate**(): `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:201

##### Returns [#returns-16]

`boolean`

#### Set Signature [#set-signature-4]

\> **set** **autoUpdate**(`value`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:203

When `true`, the Spine AnimationState and the Skeleton will be automatically updated using the [ticker](#ticker).

##### Parameters [#parameters-8]

###### value [#value-4]

`boolean`

##### Returns [#returns-17]

`void`

#### Inherited from [#inherited-from-121]

`CoreSpine.autoUpdate`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-5]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-69]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* Container#alpha For transparency
* Container#tint For color adjustments

##### Returns [#returns-18]

`BLEND_MODES`

#### Set Signature [#set-signature-5]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-9]

###### value [#value-5]

`BLEND_MODES`

##### Returns [#returns-19]

`void`

#### Inherited from [#inherited-from-122]

`CoreSpine.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-6]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:255

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-70]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-20]

`Bounds`

The rectangular bounds of the view

#### Inherited from [#inherited-from-123]

`CoreSpine.bounds`

***

### boundsProvider [#boundsprovider]

#### Get Signature [#get-signature-7]

\> **get** **boundsProvider**(): `SpineBoundsProvider` | `undefined`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:210

The bounds provider to use. If undefined the bounds will be dynamic, calculated when requested and based on the current frame.

##### Returns [#returns-21]

`SpineBoundsProvider` | `undefined`

#### Set Signature [#set-signature-6]

\> **set** **boundsProvider**(`value`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:211

##### Parameters [#parameters-10]

###### value [#value-6]

`SpineBoundsProvider` | `undefined`

##### Returns [#returns-22]

`void`

#### Inherited from [#inherited-from-124]

`CoreSpine.boundsProvider`

***

### debug [#debug]

#### Get Signature [#get-signature-8]

\> **get** **debug**(): `ISpineDebugRenderer` | `undefined`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:194

##### Returns [#returns-23]

`ISpineDebugRenderer` | `undefined`

#### Set Signature [#set-signature-7]

\> **set** **debug**(`value`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:198

Pass a SpineDebugRenderer or create your own ISpineDebugRenderer to render bones, meshes, ...

##### Example [#example-71]

```ts
spineGO.debug = new SpineDebugRenderer();
```

##### Parameters [#parameters-11]

###### value [#value-7]

`ISpineDebugRenderer` | `undefined`

##### Returns [#returns-24]

`void`

#### Inherited from [#inherited-from-125]

`CoreSpine.debug`

***

### filters [#filters]

#### Get Signature [#get-signature-9]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-72]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-25]

readonly `Filter`\[]

#### Set Signature [#set-signature-8]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-73]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-12]

###### value [#value-8]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-126]

`CoreSpine.filters`

***

### height [#height]

#### Get Signature [#get-signature-10]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-74]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-27]

`number`

#### Set Signature [#set-signature-9]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-13]

###### value [#value-9]

`number`

##### Returns [#returns-28]

`void`

#### Inherited from [#inherited-from-127]

`CoreSpine.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-11]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-29]

`boolean`

#### Inherited from [#inherited-from-128]

`CoreSpine.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-12]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-30]

`boolean`

#### Set Signature [#set-signature-10]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-14]

###### value [#value-10]

`boolean`

##### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-129]

`CoreSpine.isRenderGroup`

***

### memory [#memory]

#### Get Signature [#get-signature-13]

\> **get** **memory**(): [`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory)

Defined in: [src/components/Spine.ts:136](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L136)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-32]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory)

#### Implementation of [#implementation-of-4]

`CanvasBaseItem.memory`

***

### origin [#origin]

#### Get Signature [#get-signature-14]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-75]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-33]

`ObservablePoint`

#### Set Signature [#set-signature-11]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-15]

###### value [#value-11]

`number` | `PointData`

##### Returns [#returns-34]

`void`

#### Inherited from [#inherited-from-130]

`CoreSpine.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-15]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/components/Spine.ts:602](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L602)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-35]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-12]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/components/Spine.ts:590](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L590)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-16]

###### value [#value-12]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-36]

`void`

#### Implementation of [#implementation-of-5]

`AdditionalPositionsExtension.percentagePosition`

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-16]

\> **get** **percentageX**(): `number`

Defined in: [src/components/Spine.ts:616](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L616)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-37]

`number`

#### Set Signature [#set-signature-13]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/components/Spine.ts:608](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L608)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-17]

###### \_value [#_value]

`number`

##### Returns [#returns-38]

`void`

#### Implementation of [#implementation-of-6]

`AdditionalPositionsExtension.percentageX`

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-17]

\> **get** **percentageY**(): `number`

Defined in: [src/components/Spine.ts:627](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L627)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-39]

`number`

#### Set Signature [#set-signature-14]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/components/Spine.ts:619](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L619)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-18]

###### \_value [#_value-1]

`number`

##### Returns [#returns-40]

`void`

#### Implementation of [#implementation-of-7]

`AdditionalPositionsExtension.percentageY`

***

### physicsPositionInheritanceFactorX [#physicspositioninheritancefactorx]

#### Get Signature [#get-signature-18]

\> **get** **physicsPositionInheritanceFactorX**(): `number`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:223

Scales how much horizontal translation of this Pixi container is inherited by skeleton physics constraints.

##### Returns [#returns-41]

`number`

#### Inherited from [#inherited-from-131]

`CoreSpine.physicsPositionInheritanceFactorX`

***

### physicsPositionInheritanceFactorY [#physicspositioninheritancefactory]

#### Get Signature [#get-signature-19]

\> **get** **physicsPositionInheritanceFactorY**(): `number`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:225

Scales how much vertical translation of this Pixi container is inherited by skeleton physics constraints.

##### Returns [#returns-42]

`number`

#### Inherited from [#inherited-from-132]

`CoreSpine.physicsPositionInheritanceFactorY`

***

### physicsRotationInheritanceFactor [#physicsrotationinheritancefactor]

#### Get Signature [#get-signature-20]

\> **get** **physicsRotationInheritanceFactor**(): `number`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:237

Scales how much rotation of this Pixi container is inherited by skeleton physics constraints.
The default is `1`, which applies container rotation normally. Use `0` to prevent container
rotation from affecting physics constraints.

##### Returns [#returns-43]

`number`

#### Set Signature [#set-signature-15]

\> **set** **physicsRotationInheritanceFactor**(`value`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:238

##### Parameters [#parameters-19]

###### value [#value-13]

`number`

##### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-133]

`CoreSpine.physicsRotationInheritanceFactor`

***

### pivot [#pivot]

#### Get Signature [#get-signature-21]

\> **get** **pivot**(): `ObservablePoint`

Defined in: [src/components/Spine.ts:505](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L505)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-76]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-45]

`ObservablePoint`

#### Set Signature [#set-signature-16]

\> **set** **pivot**(`value`): `void`

Defined in: [src/components/Spine.ts:508](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L508)

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-77]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-3]

4.0.0

##### Parameters [#parameters-20]

###### value [#value-14]

`ObservablePoint`

##### Returns [#returns-46]

`void`

#### Overrides [#overrides-1]

`CoreSpine.pivot`

***

### position [#position]

#### Get Signature [#get-signature-22]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/components/Spine.ts:701](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L701)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-78]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Returns [#returns-47]

`ObservablePoint`

#### Set Signature [#set-signature-17]

\> **set** **position**(`value`): `void`

Defined in: [src/components/Spine.ts:704](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L704)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-79]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-5]

4.0.0

##### Parameters [#parameters-21]

###### value [#value-15]

`ObservablePoint`

##### Returns [#returns-48]

`void`

#### Overrides [#overrides-2]

`CoreSpine.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-23]

\> **get** **positionInfo**(): `object`

Defined in: [src/components/Spine.ts:638](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L638)

##### Returns [#returns-49]

`object`

###### type [#type]

\> **type**: `"align"` | `"pixel"` | `"percentage"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-18]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/components/Spine.ts:650](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L650)

##### Parameters [#parameters-22]

###### value [#value-16]

###### type? [#type-1]

`"align"` | `"pixel"` | `"percentage"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-50]

`void`

#### Implementation of [#implementation-of-8]

`AdditionalPositionsExtension.positionInfo`

***

### positionType [#positiontype]

#### Get Signature [#get-signature-24]

\> **get** **positionType**(): `"align"` | `"pixel"` | `"percentage"`

Defined in: [src/components/Spine.ts:630](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L630)

##### Returns [#returns-51]

`"align"` | `"pixel"` | `"percentage"`

#### Implementation of [#implementation-of-9]

`AdditionalPositionsExtension.positionType`

***

### renderable [#renderable]

#### Get Signature [#get-signature-25]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-80]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* Container#visible For skipping transform updates
* Container#alpha For transparency

##### Returns [#returns-52]

`boolean`

#### Set Signature [#set-signature-19]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-23]

###### value [#value-17]

`boolean`

##### Returns [#returns-53]

`void`

#### Inherited from [#inherited-from-134]

`CoreSpine.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-26]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-81]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-54]

`number`

#### Set Signature [#set-signature-20]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-24]

###### value [#value-18]

`number`

##### Returns [#returns-55]

`void`

#### Inherited from [#inherited-from-135]

`CoreSpine.rotation`

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-27]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-82]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-56]

`boolean`

#### Set Signature [#set-signature-21]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-25]

###### value [#value-19]

`boolean`

##### Returns [#returns-57]

`void`

#### Inherited from [#inherited-from-136]

`CoreSpine.roundPixels`

***

### scale [#scale]

#### Get Signature [#get-signature-28]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-83]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-6]

4.0.0

##### Returns [#returns-58]

`ObservablePoint`

#### Set Signature [#set-signature-22]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-26]

###### value [#value-20]

`string` | `number` | `PointData`

##### Returns [#returns-59]

`void`

#### Inherited from [#inherited-from-137]

`CoreSpine.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-29]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-84]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-7]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-60]

`ObservablePoint`

#### Set Signature [#set-signature-23]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-27]

###### value [#value-21]

`PointData`

##### Returns [#returns-61]

`void`

#### Inherited from [#inherited-from-138]

`CoreSpine.skew`

***

### ticker [#ticker]

#### Get Signature [#get-signature-30]

\> **get** **ticker**(): `Ticker`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:205

The ticker to use when [autoUpdate](#autoupdate) is `true`. Defaults to Ticker.shared.

##### Returns [#returns-62]

`Ticker`

#### Set Signature [#set-signature-24]

\> **set** **ticker**(`value`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:207

Sets the ticker to use when [autoUpdate](#autoupdate) is `true`. If `autoUpdate` is already `true`, the update callback will be moved from the old ticker to the new one.

##### Parameters [#parameters-28]

###### value [#value-22]

`Ticker`

##### Returns [#returns-63]

`void`

#### Inherited from [#inherited-from-139]

`CoreSpine.ticker`

***

### tint [#tint]

#### Get Signature [#get-signature-31]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-85]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-20]

* Container#alpha For transparency
* Container#visible For visibility control

##### Returns [#returns-64]

`number`

#### Set Signature [#set-signature-25]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-29]

###### value [#value-23]

`ColorSource`

##### Returns [#returns-65]

`void`

#### Inherited from [#inherited-from-140]

`CoreSpine.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-32]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-86]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-21]

* Container#renderable For render-only control
* Container#alpha For transparency

##### Returns [#returns-66]

`boolean`

#### Set Signature [#set-signature-26]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-30]

###### value [#value-24]

`boolean`

##### Returns [#returns-67]

`void`

#### Inherited from [#inherited-from-141]

`CoreSpine.visible`

***

### width [#width]

#### Get Signature [#get-signature-33]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-87]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-68]

`number`

#### Set Signature [#set-signature-27]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-31]

###### value [#value-25]

`number`

##### Returns [#returns-69]

`void`

#### Inherited from [#inherited-from-142]

`CoreSpine.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-34]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-88]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-22]

Container#localTransform For local space transform

##### Returns [#returns-70]

`Matrix`

#### Inherited from [#inherited-from-143]

`CoreSpine.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-35]

\> **get** **x**(): `number`

Defined in: [src/components/Spine.ts:709](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L709)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-89]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-71]

`number`

#### Set Signature [#set-signature-28]

\> **set** **x**(`value`): `void`

Defined in: [src/components/Spine.ts:712](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L712)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-32]

###### value [#value-26]

`number`

##### Returns [#returns-72]

`void`

#### Overrides [#overrides-3]

`CoreSpine.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-36]

\> **get** **xAlign**(): `number`

Defined in: [src/components/Spine.ts:557](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L557)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-73]

`number`

#### Set Signature [#set-signature-29]

\> **set** **xAlign**(`value`): `void`

Defined in: [src/components/Spine.ts:549](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L549)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-33]

###### value [#value-27]

`number`

##### Returns [#returns-74]

`void`

#### Implementation of [#implementation-of-10]

`AdditionalPositionsExtension.xAlign`

***

### y [#y-2]

#### Get Signature [#get-signature-37]

\> **get** **y**(): `number`

Defined in: [src/components/Spine.ts:717](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L717)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-91]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-75]

`number`

#### Set Signature [#set-signature-30]

\> **set** **y**(`value`): `void`

Defined in: [src/components/Spine.ts:720](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L720)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-34]

###### value [#value-28]

`number`

##### Returns [#returns-76]

`void`

#### Overrides [#overrides-4]

`CoreSpine.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-38]

\> **get** **yAlign**(): `number`

Defined in: [src/components/Spine.ts:577](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L577)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-77]

`number`

#### Set Signature [#set-signature-31]

\> **set** **yAlign**(`value`): `void`

Defined in: [src/components/Spine.ts:569](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L569)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-35]

###### value [#value-29]

`number`

##### Returns [#returns-78]

`void`

#### Implementation of [#implementation-of-11]

`AdditionalPositionsExtension.yAlign`

## Methods [#methods]

### \_getCachedData() [#_getcacheddata]

\> **\_getCachedData**(`slot`, `attachment`): `AttachmentCacheData`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:301

**`Internal`**

#### Parameters [#parameters-36]

##### slot [#slot]

`Slot`

##### attachment [#attachment]

`RegionAttachment` | `MeshAttachment`

#### Returns [#returns-79]

`AttachmentCacheData`

#### Inherited from [#inherited-from-144]

`CoreSpine._getCachedData`

***

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-37]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-80]

`void`

#### Inherited from [#inherited-from-145]

`CoreSpine._getGlobalBoundsRecursive`

***

### \_onTouch()? [#_ontouch]

\> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-38]

##### now [#now]

`number`

#### Returns [#returns-81]

`void`

#### Inherited from [#inherited-from-146]

`CoreSpine._onTouch`

***

### \_validateAndTransformAttachments() [#_validateandtransformattachments]

\> **\_validateAndTransformAttachments**(): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:282

**`Internal`**

* validates the attachments - to flag if the attachments have changed this state
* transforms the attachments - to update the vertices of the attachments based on the new positions

#### Returns [#returns-82]

`void`

#### Inherited from [#inherited-from-147]

`CoreSpine._validateAndTransformAttachments`

***

### addAnimation() [#addanimation]

\> **addAnimation**(`animationName`, `options?`): `TrackEntry`

Defined in: [src/components/Spine.ts:277](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L277)

Queues an animation to play on a track after the current animation (if any) completes. Use
[setAnimation](#setanimation) instead to replace the track's current animation immediately.

#### Parameters [#parameters-39]

##### animationName [#animationname]

`string`

The name of the animation to queue.

##### options? [#options-1]

Additional options for playing the track.

###### completeOnContinue? [#completeoncontinue]

`boolean`

If true, the animation will be completed before the next step.

**Default**

```ts
true
```

###### delay? [#delay]

`number`

Delay in seconds before the animation starts. If not provided, the animation will start immediately after the previous animation on the track, or after the mix duration if there is a previous animation.
If > 0, sets TrackEntry#delay. If \<= 0, the delay set is the duration of the previous track entry
minus any mix duration (from the AnimationStateData) plus the specified `delay` (ie the mix
ends at (`delay` = 0) or before (`delay` \< 0) the previous track entry duration). If the
previous entry is looping, its next loop completion is used instead of its duration.

###### loop? [#loop]

`boolean`

Whether the animation should loop. If true, the animation will loop indefinitely until changed.

###### trackIndex? [#trackindex]

`number`

The track index to play the animation on.

#### Returns [#returns-83]

`TrackEntry`

The `TrackEntry` for the queued animation, or `null` if the animation could not be found.

***

### addBounds() [#addbounds]

\> **addBounds**(`bounds`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:338

**`Internal`**

#### Parameters [#parameters-40]

##### bounds [#bounds-2]

`Bounds`

#### Returns [#returns-84]

`void`

#### Inherited from [#inherited-from-148]

`CoreSpine.addBounds`

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-41]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-85]

`U`\[`0`]

The first child that was added

#### Example [#example-93]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-23]

* Container#removeChild For removing children
* Container#addChildAt For adding at specific index

#### Inherited from [#inherited-from-149]

`CoreSpine.addChild`

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-1]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-42]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-86]

`U`

The child that was added

#### Example [#example-94]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-24]

* Container#addChild For adding to the end
* Container#setChildIndex For moving existing children

#### Inherited from [#inherited-from-150]

`CoreSpine.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-2]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-43]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-2]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-87]

`void`

##### Example [#example-95]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-151]

`CoreSpine.addEventListener`

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-44]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-3]

`AddListenerOptions`

##### Returns [#returns-88]

`void`

##### Inherited from [#inherited-from-152]

`CoreSpine.addEventListener`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-3]

##### T [#t]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-45]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-89]

`this`

#### Inherited from [#inherited-from-153]

`CoreSpine.addListener`

***

### addSlotObject() [#addslotobject]

\> **addSlotObject**(`slot`, `container`, `options?`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:314

Attaches a PixiJS container to a specified slot. This will map the world transform of the slots bone
to the attached container. A container can only be attached to one slot at a time.

#### Parameters [#parameters-46]

##### slot [#slot-1]

`string` | `number` | `Slot`

##### container [#container]

`Container`

The container to attach to the slot

##### options? [#options-4]

Optional settings for the attachment.

###### followAttachmentTimeline? [#followattachmenttimeline]

`boolean`

If true, the attachment will follow the slot's attachment timeline.

###### followSlotColor? [#followslotcolor]

`boolean`

If true, the container tint will follow the skeleton and slot colors.

#### Returns [#returns-90]

`void`

#### Inherited from [#inherited-from-154]

`CoreSpine.addSlotObject`

***

### clearTrack() [#cleartrack]

\> **clearTrack**(`trackIndex`): `void`

Defined in: [src/components/Spine.ts:435](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L435)

Removes all animations from a single track, stopping its running [playSequence](#playsequence) timeline (if
any), and leaving the skeleton in its current pose.

#### Parameters [#parameters-47]

##### trackIndex [#trackindex-1]

`number`

The track index to clear.

#### Returns [#returns-91]

`void`

***

### clearTracks() [#cleartracks]

\> **clearTracks**(): `void`

Defined in: [src/components/Spine.ts:423](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L423)

Removes all animations from all tracks, stopping any running [playSequence](#playsequence) timelines, and
leaving the skeleton in its current pose.

#### Returns [#returns-92]

`void`

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-48]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-93]

`void`

#### Inherited from [#inherited-from-155]

`CoreSpine.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-49]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-94]

`void`

#### Inherited from [#inherited-from-156]

`CoreSpine.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-50]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-95]

`void`

#### Inherited from [#inherited-from-157]

`CoreSpine.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

\> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-51]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-96]

`boolean`

True if the point is within the view's bounds

#### Example [#example-96]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-25]

* ViewContainer#bounds For the bounds used in hit testing
* [Container#toLocal](#tolocal) For converting global coordinates to local

#### Inherited from [#inherited-from-158]

`CoreSpine.containsPoint`

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:346

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-52]

##### options? [#options-5]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-97]

`void`

#### Inherited from [#inherited-from-159]

`CoreSpine.destroy`

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-98]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-160]

`CoreSpine.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-53]

##### e [#e]

`FederatedEvent`

The event to dispatch.

#### Returns [#returns-99]

`boolean`

Whether the FederatedEvent.preventDefault preventDefault() method was not invoked.

#### Example [#example-97]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-161]

`CoreSpine.dispatchEvent`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-1]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-54]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-100]

`boolean`

#### Inherited from [#inherited-from-162]

`CoreSpine.emit`

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-101]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-163]

`CoreSpine.enableRenderGroup`

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-102]

(keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-164]

`CoreSpine.eventNames`

***

### getBonePosition() [#getboneposition]

\> **getBonePosition**(`bone`, `outPos?`): `PointData` | `undefined`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:269

Return the position of the bone given in input into an IPointData.

#### Parameters [#parameters-55]

##### bone [#bone]

`string` | `Bone`

##### outPos? [#outpos]

`PointData`

#### Returns [#returns-103]

`PointData` | `undefined`

: the position of the bone, or undefined if no matching bone is found in the skeleton

#### Inherited from [#inherited-from-165]

`CoreSpine.getBonePosition`

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-56]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-3]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-104]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-98]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-26]

* [Container#getLocalBounds](#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-166]

`CoreSpine.getBounds`

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-5]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-57]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-105]

`U`

The child at the given index

#### Example [#example-99]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-27]

* Container#children For direct array access
* Container#getChildByLabel For name-based lookup

#### Inherited from [#inherited-from-167]

`CoreSpine.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-58]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-106]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-100]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-28]

* Container#getChildrenByLabel For finding all matches
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-168]

`CoreSpine.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-59]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-107]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-29]

Container#getChildByLabel

#### Inherited from [#inherited-from-169]

`CoreSpine.getChildByName`

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-60]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-108]

`number`

The index position of the child container

#### Example [#example-101]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-30]

* Container#setChildIndex For changing index
* Container#children For direct array access

#### Inherited from [#inherited-from-170]

`CoreSpine.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-61]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-109]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-102]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-31]

* Container#getChildByLabel For finding first match
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-171]

`CoreSpine.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-62]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-4]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-110]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-172]

`CoreSpine.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-63]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-111]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-103]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-173]

`CoreSpine.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-64]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-112]

`Point`

The updated point

#### Example [#example-104]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-32]

* [Container#toGlobal](#toglobal) For converting specific points
* [Container#toLocal](#tolocal) For converting to local space

#### Inherited from [#inherited-from-174]

`CoreSpine.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-65]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-113]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-105]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-175]

`CoreSpine.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-66]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-114]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-106]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-176]

`CoreSpine.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-115]

`Bounds`

The bounding area

#### Example [#example-107]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-33]

* [Container#getBounds](#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-177]

`CoreSpine.getLocalBounds`

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-67]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-116]

`Size`

The size of the container.

#### Example [#example-108]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

#### Inherited from [#inherited-from-178]

`CoreSpine.getSize`

***

### getSlotObject() [#getslotobject]

\> **getSlotObject**(`slot`): `Container`\<`ContainerChild`> | `undefined`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:335

Returns a container attached to a slot, or undefined if no container is attached.

#### Parameters [#parameters-68]

##### slot [#slot-2]

`string` | `number` | `Slot`

#### Returns [#returns-117]

`Container`\<`ContainerChild`> | `undefined`

* The container attached to the slot

#### Inherited from [#inherited-from-179]

`CoreSpine.getSlotObject`

***

### internalUpdate() [#internalupdate]

\> `protected` **internalUpdate**(`ticker?`, `deltaSeconds?`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:242

#### Parameters [#parameters-69]

##### ticker? [#ticker-1]

`Ticker`

##### deltaSeconds? [#deltaseconds]

`number`

#### Returns [#returns-118]

`void`

#### Inherited from [#inherited-from-180]

`CoreSpine.internalUpdate`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-70]

##### event [#event-2]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-119]

`number`

#### Inherited from [#inherited-from-181]

`CoreSpine.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-2]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-71]

##### event [#event-3]

`T`

#### Returns [#returns-120]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-182]

`CoreSpine.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-7]

##### T [#t-3]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-72]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-121]

`this`

#### Inherited from [#inherited-from-183]

`CoreSpine.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/components/Spine.ts:460](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L460)

Add a listener for a given event.

#### Type Parameters [#type-parameters-8]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents<ContainerChild>

#### Parameters [#parameters-73]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-122]

`this`

#### Implementation of [#implementation-of-12]

`ListenerExtension.on`

#### Overrides [#overrides-5]

`CoreSpine.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-5]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-74]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-123]

`this`

#### Inherited from [#inherited-from-184]

`CoreSpine.once`

***

### pixiWorldCoordinatesToBone() [#pixiworldcoordinatestobone]

\> **pixiWorldCoordinatesToBone**(`point`, `bone`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:366

Converts a point from the Pixi world coordinate system to the bone's local coordinate system.

#### Parameters [#parameters-75]

##### point [#point-2]

###### x [#x-3]

`number`

###### y [#y-3]

`number`

##### bone [#bone-1]

`Bone`

#### Returns [#returns-124]

`void`

#### Inherited from [#inherited-from-185]

`CoreSpine.pixiWorldCoordinatesToBone`

***

### pixiWorldCoordinatesToSkeleton() [#pixiworldcoordinatestoskeleton]

\> **pixiWorldCoordinatesToSkeleton**(`point`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:361

Converts a point from the Pixi world coordinate system to the skeleton coordinate system.

#### Parameters [#parameters-76]

##### point [#point-3]

###### x [#x-4]

`number`

###### y [#y-4]

`number`

#### Returns [#returns-125]

`void`

#### Inherited from [#inherited-from-186]

`CoreSpine.pixiWorldCoordinatesToSkeleton`

***

### playSequence() [#playsequence]

\> **playSequence**(`sequence`, `options?`): `Omit`\<`AnimationPlaybackControlsWithThen`, `"pause"`>

Defined in: [src/components/Spine.ts:333](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L333)

Plays a sequence of animations on a track, one after another, driven by a `motion` timeline. Any
animation currently playing on the track is cleared first. The sequence is tracked in
sequenceTimelines (and thus included in [memory](#memory)) until it completes, at which point
the track is cleared automatically.

#### Parameters [#parameters-77]

##### sequence [#sequence]

(`string` | \[`string`, [`SpineSequenceOptions`](/pixi-vn-spine/index/type-aliases/SpineSequenceOptions)])\[]

The sequence of animations to play, with their respective options. Corresponds to the motion sequence settings: [https://motion.dev/docs/animate#timeline-sequences](https://motion.dev/docs/animate#timeline-sequences)

##### options? [#options-6]

`SequenceOptions` & `object` = `{}`

Additional options for playing the track.

#### Returns [#returns-126]

`Omit`\<`AnimationPlaybackControlsWithThen`, `"pause"`>

The `motion` timeline controls for the sequence (without `pause`, since pausing is not supported).

#### Example [#example-109]

```ts
spine.playSequence([
    ["walk", { loop: true, duration: 2 }],
    ["jump", { delay: 0.5 }],
], { loop: true, completeOnContinue: true });
```

***

### reloadAnchor() [#reloadanchor]

\> `protected` **reloadAnchor**(): `void`

Defined in: [src/components/Spine.ts:500](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L500)

#### Returns [#returns-127]

`void`

***

### reloadPosition() [#reloadposition]

\> `protected` **reloadPosition**(): `void`

Defined in: [src/components/Spine.ts:664](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L664)

Re-applies whichever positioning mode is active ([align](#align) or [percentagePosition](#percentageposition)) onto
the underlying pixel [x](#x)/[y](#y), e.g. after the skeleton's size, scale or angle changes.
No-op when neither mode is set (plain pixel positioning).

#### Returns [#returns-128]

`void`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-78]

##### event? [#event-7]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-129]

`this`

#### Inherited from [#inherited-from-187]

`CoreSpine.removeAllListeners`

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-10]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-79]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-130]

`U`\[`0`]

The first child that was removed

#### Example [#example-110]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-34]

* Container#addChild For adding children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-188]

`CoreSpine.removeChild`

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-11]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-80]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-131]

`U`

The child that was removed

#### Example [#example-111]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-35]

* Container#removeChild For removing specific children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-189]

`CoreSpine.removeChildAt`

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-81]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-132]

`ContainerChild`\[]

List of removed children

#### Example [#example-112]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-36]

* Container#addChild For adding children
* Container#removeChild For removing specific children

#### Inherited from [#inherited-from-190]

`CoreSpine.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-12]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-82]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-7]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-133]

`void`

##### Inherited from [#inherited-from-191]

`CoreSpine.removeEventListener`

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-83]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-8]

`RemoveListenerOptions`

##### Returns [#returns-134]

`void`

##### Inherited from [#inherited-from-192]

`CoreSpine.removeEventListener`

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-135]

`void`

#### Example [#example-113]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-37]

* Container#addChild For adding to a new parent
* Container#removeChild For parent removing children

#### Inherited from [#inherited-from-193]

`CoreSpine.removeFromParent`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-13]

##### T [#t-6]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-84]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-136]

`this`

#### Inherited from [#inherited-from-194]

`CoreSpine.removeListener`

***

### removeSlotObject() [#removeslotobject]

\> **removeSlotObject**(`slotOrContainer`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:324

Removes a PixiJS container from the slot it is attached to.

#### Parameters [#parameters-85]

##### slotOrContainer [#slotorcontainer]

`string` | `number` | `Container`\<`ContainerChild`> | `Slot`

The container, slot id or slot to detach from

#### Returns [#returns-137]

`void`

#### Inherited from [#inherited-from-195]

`CoreSpine.removeSlotObject`

***

### removeSlotObjects() [#removeslotobjects]

\> **removeSlotObjects**(): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:328

Removes all PixiJS containers attached to any slot.

#### Returns [#returns-138]

`void`

#### Inherited from [#inherited-from-196]

`CoreSpine.removeSlotObjects`

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-14]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-86]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-139]

`U`\[`0`]

The first child that was reparented

#### Example [#example-114]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-38]

* Container#reparentChildAt For index-specific reparenting
* Container#addChild For simple parenting

#### Inherited from [#inherited-from-197]

`CoreSpine.reparentChild`

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-87]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-140]

`U`

The reparented child

#### Example [#example-115]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-39]

* Container#reparentChild For appending reparented children
* Container#addChildAt For simple indexed parenting

#### Inherited from [#inherited-from-198]

`CoreSpine.reparentChildAt`

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-16]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-88]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-141]

`void`

#### Inherited from [#inherited-from-199]

`CoreSpine.replaceChild`

***

### resetPhysicsPosition() [#resetphysicsposition]

\> **resetPhysicsPosition**(): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:244

Resets the position used for calculating inherited physics translation.

#### Returns [#returns-142]

`void`

#### Inherited from [#inherited-from-200]

`CoreSpine.resetPhysicsPosition`

***

### resetPhysicsRotation() [#resetphysicsrotation]

\> **resetPhysicsRotation**(): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:246

Resets the rotation used for calculating inherited physics rotation.

#### Returns [#returns-143]

`void`

#### Inherited from [#inherited-from-201]

`CoreSpine.resetPhysicsRotation`

***

### resetPhysicsTransform() [#resetphysicstransform]

\> **resetPhysicsTransform**(): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:248

Resets the transform used for calculating inherited physics translation and rotation.

#### Returns [#returns-144]

`void`

#### Inherited from [#inherited-from-202]

`CoreSpine.resetPhysicsTransform`

***

### setAnimation() [#setanimation]

\> **setAnimation**(`animationName`, `options`): `TrackEntry`

Defined in: [src/components/Spine.ts:239](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L239)

Sets the current animation on a track, replacing whatever is currently playing on it. Use
[addAnimation](#addanimation) instead to queue an animation after the current one.

#### Parameters [#parameters-89]

##### animationName [#animationname-1]

`string`

The name of the animation to set.

##### options [#options-9]

Additional options for setting the animation.

###### completeOnContinue? [#completeoncontinue-1]

`boolean`

If true, the animation will be completed before the next step.

**Default**

```ts
true
```

###### loop? [#loop-1]

`boolean`

Whether the animation should loop. If true, the animation will loop indefinitely until changed.

###### trackIndex [#trackindex-2]

`number`

The track index to play the animation on.

#### Returns [#returns-145]

`TrackEntry`

The `TrackEntry` for the animation, or `null` if the animation could not be found.

***

### setBonePosition() [#setboneposition]

\> **setBonePosition**(`bone`, `position`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:262

Set the position of the bone given in input through a IPointData.

#### Parameters [#parameters-90]

##### bone [#bone-2]

`string` | `Bone`

##### position [#position-1]

`PointData`

#### Returns [#returns-146]

`void`

#### Throws [#throws-7]

: if the given bone is not found in the skeleton, an error is thrown

#### Inherited from [#inherited-from-203]

`CoreSpine.setBonePosition`

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-91]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-147]

`void`

#### Example [#example-116]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-8]

If index is out of bounds

#### Throws [#throws-9]

If child is not in container

#### See [#see-40]

* Container#getChildIndex For getting current index
* Container#swapChildren For swapping positions

#### Inherited from [#inherited-from-204]

`CoreSpine.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-92]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-148]

`void`

#### Example [#example-117]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-41]

* Container#updateTransform For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-205]

`CoreSpine.setFromMatrix`

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-93]

##### options [#options-10]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-149]

`void`

#### Example [#example-118]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-42]

* [Container#mask](#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-206]

`CoreSpine.setMask`

***

### setMemory() [#setmemory]

\> **setMemory**(`memory`): `Promise`\<`void`>

Defined in: [src/components/Spine.ts:227](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L227)

This method set the memory of the canvas element.

#### Parameters [#parameters-94]

##### memory [#memory-1]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory)

#### Returns [#returns-150]

`Promise`\<`void`>

#### Throws [#throws-10]

when the method is not overridden in the subclass.

#### Implementation of [#implementation-of-13]

`CanvasBaseItem.setMemory`

***

### setPhysicsPositionInheritanceFactor() [#setphysicspositioninheritancefactor]

\> **setPhysicsPositionInheritanceFactor**(`x`, `y`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:231

Sets how much translation of this Pixi container is inherited by skeleton physics constraints.
The default is (1, 1), which applies container translation normally. Use (0, 0)
to prevent container translation from affecting physics constraints.

#### Parameters [#parameters-95]

##### x [#x-5]

`number`

##### y [#y-5]

`number`

#### Returns [#returns-151]

`void`

#### Inherited from [#inherited-from-207]

`CoreSpine.setPhysicsPositionInheritanceFactor`

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-96]

##### value [#value-30]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-152]

`void`

#### Example [#example-119]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

#### Inherited from [#inherited-from-208]

`CoreSpine.setSize`

***

### setSkin() [#setskin]

\> **setSkin**(`skinName`): `void`

Defined in: [src/components/Spine.ts:445](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/components/Spine.ts#L445)

Sets the active skin on the skeleton and refreshes its pose slots accordingly. Failures (e.g. an
unknown skin name) are logged via logger.error rather than thrown.

#### Parameters [#parameters-97]

##### skinName [#skinname]

`string`

The name of the skin to set.

#### Returns [#returns-153]

`void`

***

### skeletonToPixiWorldCoordinates() [#skeletontopixiworldcoordinates]

\> **skeletonToPixiWorldCoordinates**(`point`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:356

Converts a point from the skeleton coordinate system to the Pixi world coordinate system.

#### Parameters [#parameters-98]

##### point [#point-4]

###### x [#x-6]

`number`

###### y [#y-6]

`number`

#### Returns [#returns-154]

`void`

#### Inherited from [#inherited-from-209]

`CoreSpine.skeletonToPixiWorldCoordinates`

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-17]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-99]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-155]

`void`

#### Example [#example-120]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-11]

If either child is not in container

#### See [#see-43]

* Container#setChildIndex For direct index placement
* Container#getChildIndex For getting current positions

#### Inherited from [#inherited-from-210]

`CoreSpine.swapChildren`

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-18]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-100]

##### position [#position-2]

`PointData`

The local point to convert

##### point? [#point-5]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-156]

`P`

The global position

#### Example [#example-121]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-44]

* [Container#toLocal](#tolocal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-211]

`CoreSpine.toGlobal`

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-19]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-101]

##### position [#position-3]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-6]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-157]

`P`

A point object representing the position in local space

#### Example [#example-122]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-45]

* [Container#toGlobal](#toglobal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-212]

`CoreSpine.toLocal`

***

### unload() [#unload]

\> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-158]

`void`

#### Inherited from [#inherited-from-213]

`CoreSpine.unload`

***

### unloadFromCache() [#unloadfromcache]

\> **unloadFromCache**(): `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:354

Unloads this Spine object's cached SkeletonData.

Existing Spine objects that use this SkeletonData continue to work. Future Spine objects created with the same
skeleton, atlas, and scale will parse a new SkeletonData.

#### Returns [#returns-159]

`boolean`

`true` if the cached SkeletonData was removed, otherwise `false`.

#### Inherited from [#inherited-from-214]

`CoreSpine.unloadFromCache`

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:241

If [Spine.autoUpdate](#autoupdate) is `false`, this method allows to update the AnimationState and the Skeleton with the given delta.

#### Parameters [#parameters-102]

##### dt [#dt]

`number`

#### Returns [#returns-160]

`void`

#### Inherited from [#inherited-from-215]

`CoreSpine.update`

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-161]

`void`

#### Inherited from [#inherited-from-216]

`CoreSpine.updateLocalTransform`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-103]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-162]

`this`

This container, for chaining

#### Example [#example-123]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-46]

* Container#setFromMatrix For matrix-based transforms
* Container#position For direct position access

#### Inherited from [#inherited-from-217]

`CoreSpine.updateTransform`

***

### createOptions() [#createoptions]

\> `static` **createOptions**(`options`): `SpineOptions`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:384

Get a convenient initialization configuration for your Spine game object.
Before instantiating a Spine game object, the skeleton (`.skel` or `.json`) and the atlas text files must be loaded into the Assets. For example:

```
PIXI.Assets.add("sackData", "/assets/sack-pro.skel");
PIXI.Assets.add("sackAtlas", "/assets/sack-pma.atlas");
await PIXI.Assets.load(["sackData", "sackAtlas"]);
```

Once a Spine game object is created, its skeleton data is cached into Cache using the key:
`${skeletonAssetName}-${atlasAssetName}-${options?.scale ?? 1}`

#### Parameters [#parameters-104]

##### options [#options-11]

`SpineFromOptions`

Options to configure the Spine game object. See SpineFromOptions

#### Returns [#returns-163]

`SpineOptions`

The configuration ready to be passed to the Spine constructor

#### Inherited from [#inherited-from-218]

`CoreSpine.createOptions`

***

### ~~from()~~ [#from-1]

\> `static` **from**(`options`): `Spine`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:402

#### Parameters [#parameters-105]

##### options [#options-12]

`SpineFromOptions`

Options to configure the Spine game object. See SpineFromOptions

#### Returns [#returns-164]

`Spine`

The Spine game object instantiated

#### Deprecated [#deprecated-3]

Use directly the Spine constructor or [createOptions](#createoptions) to make options and customize it to pass to the constructor
Use this method to instantiate a Spine game object.
Before instantiating a Spine game object, the skeleton (`.skel` or `.json`) and the atlas text files must be loaded into the Assets. For example:

```
PIXI.Assets.add("sackData", "/assets/sack-pro.skel");
PIXI.Assets.add("sackAtlas", "/assets/sack-pma.atlas");
await PIXI.Assets.load(["sackData", "sackAtlas"]);
```

Once a Spine game object is created, its skeleton data is cached into Cache using the key:
`${skeletonAssetName}-${atlasAssetName}-${options?.scale ?? 1}`

#### Inherited from [#inherited-from-219]

`CoreSpine.from`

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-106]

##### source [#source]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-165]

`void`

#### Deprecated [#deprecated-4]

since 8.8.0

#### Inherited from [#inherited-from-220]

`CoreSpine.mixin`


# index (/pixi-vn-spine/index)



## Classes [#classes]

* [Spine](/pixi-vn-spine/index/classes/Spine)

## Interfaces [#interfaces]

* [SpineMemory](/pixi-vn-spine/index/interfaces/SpineMemory)
* [SpineOptions](/pixi-vn-spine/index/interfaces/SpineOptions)
* [TrackMemory](/pixi-vn-spine/index/interfaces/TrackMemory)

## Type Aliases [#type-aliases]

* [SpineSequenceOptions](/pixi-vn-spine/index/type-aliases/SpineSequenceOptions)


# Interface: SpineMemory (/pixi-vn-spine/index/interfaces/SpineMemory)



Defined in: [src/interfaces/SpineMemory.ts:64](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineMemory.ts#L64)

## Extends [#extends]

* `MemoryCore`.`CanvasBaseItemMemory`.`ListenerExtensionMemory`.`AdditionalPositionsExtensionProps`.`AnchorExtensionProps`.`Omit`\<[`SpineOptions`](/pixi-vn-spine/index/interfaces/SpineOptions), `"scale"` | `"skin"` | `"animation"`>

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`MemoryCore.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`MemoryCore.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`MemoryCore.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`MemoryCore.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`MemoryCore.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`MemoryCore.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`MemoryCore.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:232

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`AdditionalPositionsExtensionProps.align`

***

### allowMissingRegions? [#allowmissingregions]

\> `optional` **allowMissingRegions?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:53

Set AtlasAttachmentLoader.allowMissingRegions property on the AtlasAttachmentLoader.

#### Inherited from [#inherited-from-8]

`Omit.allowMissingRegions`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-9]

`MemoryCore.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:670

#### Inherited from [#inherited-from-10]

`AnchorExtensionProps.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-11]

`MemoryCore.angle`

***

### atlas [#atlas]

\> **atlas**: `string`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:39

the asset name for the atlas file previously loaded into the Assets

#### Inherited from [#inherited-from-12]

`Omit.atlas`

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:119

See SpineFromOptions.autoUpdate.

#### Inherited from [#inherited-from-13]

`MemoryCore.autoUpdate`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-14]

`MemoryCore.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-15]

`Omit.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-16]

`Omit.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-17]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-18]

`MemoryCore.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-19]

`MemoryCore.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-20]

`Omit.cullArea`

***

### currentSkin? [#currentskin]

\> `optional` **currentSkin?**: `string`

Defined in: [src/interfaces/SpineMemory.ts:72](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineMemory.ts#L72)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-21]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`cursor`](/pixi-vn-spine/index/classes/Spine#cursor)

***

### darkTint? [#darktint]

\> `optional` **darkTint?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:49

If `true`, use the dark tint renderer to render the skeleton
If `false`, use the default pixi renderer to render the skeleton
If `undefined`, use the dark tint renderer if at least one slot has tint black

#### Inherited from [#inherited-from-22]

`Omit.darkTint`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-23]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`eventMode`](/pixi-vn-spine/index/classes/Spine#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-24]

`Omit.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-25]

`MemoryCore.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-26]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`hitArea`](/pixi-vn-spine/index/classes/Spine#hitarea)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:182

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-27]

`CanvasBaseItemMemory.index`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-spine/index/classes/Spine#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-28]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`interactive`](/pixi-vn-spine/index/classes/Spine#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-29]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`interactiveChildren`](/pixi-vn-spine/index/classes/Spine#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-30]

`MemoryCore.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-31]

`MemoryCore.label`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`Omit.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-32]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onclick`](/pixi-vn-spine/index/classes/Spine#onclick)

***

### onEvents? [#onevents]

> `optional` **onEvents?**: `OnEventsHandlers`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:357

#### Inherited from [#inherited-from-33]

`ListenerExtensionMemory.onEvents`

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-34]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobalmousemove`](/pixi-vn-spine/index/classes/Spine#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-35]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobalpointermove`](/pixi-vn-spine/index/classes/Spine#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-36]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobaltouchmove`](/pixi-vn-spine/index/classes/Spine#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmousedown`](/pixi-vn-spine/index/classes/Spine#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseenter`](/pixi-vn-spine/index/classes/Spine#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseleave`](/pixi-vn-spine/index/classes/Spine#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmousemove`](/pixi-vn-spine/index/classes/Spine#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseout`](/pixi-vn-spine/index/classes/Spine#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseover`](/pixi-vn-spine/index/classes/Spine#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseup`](/pixi-vn-spine/index/classes/Spine#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseupoutside`](/pixi-vn-spine/index/classes/Spine#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointercancel`](/pixi-vn-spine/index/classes/Spine#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerdown`](/pixi-vn-spine/index/classes/Spine#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerenter`](/pixi-vn-spine/index/classes/Spine#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerleave`](/pixi-vn-spine/index/classes/Spine#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointermove`](/pixi-vn-spine/index/classes/Spine#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerout`](/pixi-vn-spine/index/classes/Spine#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerover`](/pixi-vn-spine/index/classes/Spine#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointertap`](/pixi-vn-spine/index/classes/Spine#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerup`](/pixi-vn-spine/index/classes/Spine#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerupoutside`](/pixi-vn-spine/index/classes/Spine#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-55]

`Omit.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightclick`](/pixi-vn-spine/index/classes/Spine#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightdown`](/pixi-vn-spine/index/classes/Spine#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightup`](/pixi-vn-spine/index/classes/Spine#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightupoutside`](/pixi-vn-spine/index/classes/Spine#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontap`](/pixi-vn-spine/index/classes/Spine#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchcancel`](/pixi-vn-spine/index/classes/Spine#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchend`](/pixi-vn-spine/index/classes/Spine#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchendoutside`](/pixi-vn-spine/index/classes/Spine#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-64]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchmove`](/pixi-vn-spine/index/classes/Spine#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-65]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchstart`](/pixi-vn-spine/index/classes/Spine#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-66]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onwheel`](/pixi-vn-spine/index/classes/Spine#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-67]

`MemoryCore.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-68]

`Omit.parent`

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:186

The label of the parent container, if it has one

#### Inherited from [#inherited-from-69]

`CanvasBaseItemMemory.parentLabel`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:262

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-70]

`AdditionalPositionsExtensionProps.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:272

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-71]

`AdditionalPositionsExtensionProps.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:282

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-72]

`AdditionalPositionsExtensionProps.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-73]

`MemoryCore.pivot`

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:178

#### Inherited from [#inherited-from-74]

`CanvasBaseItemMemory.pixivnId`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-75]

`MemoryCore.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-76]

`MemoryCore.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-77]

`MemoryCore.rotation`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-78]

`MemoryCore.scale`

***

### sequenceTimelines [#sequencetimelines]

> **sequenceTimelines**: `object`

Defined in: [src/interfaces/SpineMemory.ts:73](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineMemory.ts#L73)

#### Index Signature [#index-signature]

\[`track`: `number`]: `object`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-79]

`Omit.setMask`

***

### skeleton [#skeleton]

> **skeleton**: `string`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:37

the asset name for the skeleton `.skel` or `.json` file previously loaded into the Assets

#### Inherited from [#inherited-from-80]

`Omit.skeleton`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-81]

`MemoryCore.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-82]

`MemoryCore.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-83]

`MemoryCore.sortDirty`

***

### state [#state]

> **state**: `object`

Defined in: [src/interfaces/SpineMemory.ts:71](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineMemory.ts#L71)

#### tracks [#tracks]

> **tracks**: ([`TrackMemory`](/pixi-vn-spine/index/interfaces/TrackMemory) | `null`)\[]

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-84]

`MemoryCore.tabIndex`

***

### ticker? [#ticker]

> `optional` **ticker?**: `Ticker`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:125

See SpineFromOptions.ticker.

#### Inherited from [#inherited-from-85]

`MemoryCore.ticker`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-86]

`MemoryCore.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-87]

`MemoryCore.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-88]

`MemoryCore.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-89]

`MemoryCore.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:242

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-90]

`AdditionalPositionsExtensionProps.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-91]

`MemoryCore.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:252

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-92]

`AdditionalPositionsExtensionProps.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-spine/index/classes/Spine#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-93]

`MemoryCore.zIndex`


# Interface: SpineOptions (/pixi-vn-spine/index/interfaces/SpineOptions)



Defined in: [src/interfaces/SpineOptions.ts:4](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineOptions.ts#L4)

## Extends [#extends]

* `Omit`\<`SpineFromOptions`, `"boundsProvider"` | `"parent"`>.`Omit`\<`ContainerOptions`, `"scale"`>

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`Omit.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`Omit.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`Omit.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`Omit.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`Omit.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`Omit.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`Omit.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:232

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`align`](/pixi-vn-spine/index/interfaces/SpineMemory#align)

***

### allowMissingRegions? [#allowmissingregions]

\> `optional` **allowMissingRegions?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:53

Set AtlasAttachmentLoader.allowMissingRegions property on the AtlasAttachmentLoader.

#### Inherited from [#inherited-from-8]

`Omit.allowMissingRegions`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-9]

`Omit.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:670

#### Inherited from [#inherited-from-10]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`anchor`](/pixi-vn-spine/index/interfaces/SpineMemory#anchor)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-11]

`Omit.angle`

***

### animation? [#animation]

\> `optional` **animation?**: `string`

Defined in: [src/interfaces/SpineOptions.ts:17](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineOptions.ts#L17)

The name of the animation to play in loop
on track 0 as soon as the skeleton is created, equivalent
to calling [Spine.addAnimation](/pixi-vn-spine/index/classes/Spine#addanimation) right after construction.

***

### atlas [#atlas]

\> **atlas**: `string`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:39

the asset name for the atlas file previously loaded into the Assets

#### Inherited from [#inherited-from-12]

`Omit.atlas`

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:43

Set the [Spine.autoUpdate](/pixi-vn-spine/index/classes/Spine#autoupdate) value. If omitted, it is set to `true`.

#### Inherited from [#inherited-from-13]

`Omit.autoUpdate`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-8]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-14]

`Omit.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-15]

`Omit.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-16]

`Omit.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-17]

`Omit.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-9]

```ts
false
```

#### Inherited from [#inherited-from-18]

`Omit.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-19]

`Omit.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-11]

```ts
null
```

#### Inherited from [#inherited-from-20]

`Omit.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-12]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-21]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`cursor`](/pixi-vn-spine/index/classes/Spine#cursor)

***

### darkTint? [#darktint]

\> `optional` **darkTint?**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:49

If `true`, use the dark tint renderer to render the skeleton
If `false`, use the default pixi renderer to render the skeleton
If `undefined`, use the dark tint renderer if at least one slot has tint black

#### Inherited from [#inherited-from-22]

`Omit.darkTint`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-23]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`eventMode`](/pixi-vn-spine/index/classes/Spine#eventmode)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-24]

`Omit.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-13]

```ts
0
```

#### Inherited from [#inherited-from-25]

`Omit.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-26]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`hitArea`](/pixi-vn-spine/index/classes/Spine#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-spine/index/classes/Spine#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-27]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`interactive`](/pixi-vn-spine/index/classes/Spine#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-14]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-28]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`interactiveChildren`](/pixi-vn-spine/index/classes/Spine#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-29]

`Omit.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-30]

`Omit.label`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`Omit.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-31]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onclick`](/pixi-vn-spine/index/classes/Spine#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobalmousemove`](/pixi-vn-spine/index/classes/Spine#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-33]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobalpointermove`](/pixi-vn-spine/index/classes/Spine#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-34]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onglobaltouchmove`](/pixi-vn-spine/index/classes/Spine#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-35]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmousedown`](/pixi-vn-spine/index/classes/Spine#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-36]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseenter`](/pixi-vn-spine/index/classes/Spine#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-37]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseleave`](/pixi-vn-spine/index/classes/Spine#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-38]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmousemove`](/pixi-vn-spine/index/classes/Spine#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-39]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseout`](/pixi-vn-spine/index/classes/Spine#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseover`](/pixi-vn-spine/index/classes/Spine#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-41]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseup`](/pixi-vn-spine/index/classes/Spine#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-42]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onmouseupoutside`](/pixi-vn-spine/index/classes/Spine#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-43]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointercancel`](/pixi-vn-spine/index/classes/Spine#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerdown`](/pixi-vn-spine/index/classes/Spine#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerenter`](/pixi-vn-spine/index/classes/Spine#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerleave`](/pixi-vn-spine/index/classes/Spine#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointermove`](/pixi-vn-spine/index/classes/Spine#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerout`](/pixi-vn-spine/index/classes/Spine#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerover`](/pixi-vn-spine/index/classes/Spine#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointertap`](/pixi-vn-spine/index/classes/Spine#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerup`](/pixi-vn-spine/index/classes/Spine#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onpointerupoutside`](/pixi-vn-spine/index/classes/Spine#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-53]

`Omit.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightclick`](/pixi-vn-spine/index/classes/Spine#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightdown`](/pixi-vn-spine/index/classes/Spine#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightup`](/pixi-vn-spine/index/classes/Spine#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onrightupoutside`](/pixi-vn-spine/index/classes/Spine#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontap`](/pixi-vn-spine/index/classes/Spine#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchcancel`](/pixi-vn-spine/index/classes/Spine#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchend`](/pixi-vn-spine/index/classes/Spine#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchendoutside`](/pixi-vn-spine/index/classes/Spine#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-62]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchmove`](/pixi-vn-spine/index/classes/Spine#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`ontouchstart`](/pixi-vn-spine/index/classes/Spine#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-64]

[`Spine`](/pixi-vn-spine/index/classes/Spine).[`onwheel`](/pixi-vn-spine/index/classes/Spine#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-65]

`Omit.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-66]

`Omit.parent`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:262

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-67]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`percentagePosition`](/pixi-vn-spine/index/interfaces/SpineMemory#percentageposition)

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:272

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`percentageX`](/pixi-vn-spine/index/interfaces/SpineMemory#percentagex)

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:282

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`percentageY`](/pixi-vn-spine/index/interfaces/SpineMemory#percentagey)

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-70]

`Omit.pivot`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-71]

`Omit.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-49]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-72]

`Omit.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-73]

`Omit.rotation`

***

### scale? [#scale]

> `optional` **scale?**: `number`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:41

The value passed to the skeleton reader. If omitted, 1 is passed. See SkeletonBinary.scale for details.

#### Inherited from [#inherited-from-74]

`Omit.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-75]

`Omit.setMask`

***

### skeleton [#skeleton]

> **skeleton**: `string`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:37

the asset name for the skeleton `.skel` or `.json` file previously loaded into the Assets

#### Inherited from [#inherited-from-76]

`Omit.skeleton`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-61]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-50]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-77]

`Omit.skew`

***

### skin? [#skin]

> `optional` **skin?**: `string`

Defined in: [src/interfaces/SpineOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineOptions.ts#L11)

The name of the skin to set on the skeleton as soon as it is created, equivalent to calling
[Spine.setSkin](/pixi-vn-spine/index/classes/Spine#setskin) right after construction.

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-62]

```ts
container.sortableChildren = true;
```

#### Default [#default-51]

```ts
false
```

#### Inherited from [#inherited-from-78]

`Omit.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-52]

```ts
false
@internal
```

#### Inherited from [#inherited-from-79]

`Omit.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-53]

```ts
0
```

#### Example [#example-63]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-80]

`Omit.tabIndex`

***

### ticker? [#ticker]

> `optional` **ticker?**: `Ticker`

Defined in: node_modules/@esotericsoftware/spine-pixi-v8/dist/Spine.d.ts:55

The ticker to use when [autoUpdate](#autoupdate) is `true`. Defaults to Ticker.shared.

#### Inherited from [#inherited-from-81]

`Omit.ticker`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-64]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-54]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-82]

`Omit.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-65]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-55]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-83]

`Omit.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-66]

```ts
new Container({ width: 100});
```

#### Default [#default-56]

```ts
0
```

#### Inherited from [#inherited-from-84]

`Omit.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-67]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-85]

`Omit.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:242

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-86]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`xAlign`](/pixi-vn-spine/index/interfaces/SpineMemory#xalign)

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-68]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-87]

`Omit.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:252

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-88]

[`SpineMemory`](/pixi-vn-spine/index/interfaces/SpineMemory).[`yAlign`](/pixi-vn-spine/index/interfaces/SpineMemory#yalign)

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-69]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-spine/index/classes/Spine#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-57]

```ts
0
```

#### Inherited from [#inherited-from-89]

`Omit.zIndex`


# Interface: TrackMemory (/pixi-vn-spine/index/interfaces/TrackMemory)



Defined in: [src/interfaces/TrackMemory.ts:3](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/TrackMemory.ts#L3)

## Extends [#extends]

* `Omit`\<`Pick`\<`TrackEntry`, `"loop"` | `"trackIndex"` | `"delay"`>, `"animation"`>

## Properties [#properties]

### animationName [#animationname]

\> **animationName**: `string`

Defined in: [src/interfaces/TrackMemory.ts:5](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/TrackMemory.ts#L5)

***

### delay [#delay]

\> **delay**: `number`

Defined in: node_modules/@esotericsoftware/spine-core/dist/AnimationState.d.ts:264

Seconds to postpone playing the animation. Must be >= 0. When this track entry is the current track entry,
`delay` postpones incrementing the trackTime. When this track entry is queued, `delay` is
the time from the start of the previous animation to when this track entry will become the current track entry (ie when
the previous track entry trackTime >= this track entry's `delay`).

timeScale affects the delay.

When passing `delay` \<= 0 to AnimationState.addAnimation this
`delay` is set using a mix duration from AnimationStateData. To change the mixDuration
afterward, use setMixDuration so this `delay` is adjusted.

#### Inherited from [#inherited-from]

`Omit.delay`

***

### loop [#loop]

\> **loop**: `boolean`

Defined in: node_modules/@esotericsoftware/spine-core/dist/AnimationState.d.ts:208

If true, the animation will repeat. If false it will not, instead its last frame is applied if played beyond its
duration.

#### Inherited from [#inherited-from-1]

`Omit.loop`

***

### trackIndex [#trackindex]

\> **trackIndex**: `number`

Defined in: node_modules/@esotericsoftware/spine-core/dist/AnimationState.d.ts:205

The index of the track where this track entry is either current or queued.

See AnimationState.getTrack.

#### Inherited from [#inherited-from-2]

`Omit.trackIndex`


# Type Alias: SpineSequenceOptions (/pixi-vn-spine/index/type-aliases/SpineSequenceOptions)



\> **SpineSequenceOptions** = `Pick`\<`AnimationOptionsCommon`, `"duration"`> & `object`

Defined in: [src/interfaces/SpineSequenceOptions.ts:3](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/interfaces/SpineSequenceOptions.ts#L3)

## Type Declaration [#type-declaration]

### delay? [#delay]

\> `optional` **delay?**: `number`

Delay in seconds before the animation starts. If not provided, the animation will start immediately after the previous animation on the track, or after the mix duration if there is a previous animation.
If > 0, sets TrackEntry#delay. If \<= 0, the delay set is the duration of the previous track entry
minus any mix duration (from the AnimationStateData) plus the specified `delay` (ie the mix
ends at (`delay` = 0) or before (`delay` \< 0) the previous track entry duration). If the
previous entry is looping, its next loop completion is used instead of its duration.

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Whether the animation should loop. If true, the animation will loop indefinitely until changed.


# Function: createSpineHandler() (/pixi-vn-spine/ink/functions/createSpineHandler)



\> **createSpineHandler**(): `void`

Defined in: [src/ink/spineHandler.ts:109](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/ink/spineHandler.ts#L109)

Registers the `# show spine` Ink hashtag command, letting Ink scripts show a [Spine](/pixi-vn-spine/index/classes/Spine)
canvas element the same way `@drincs/pixi-vn-ink`'s built-in `# show image` shows an
`ImageSprite`: `<alias>` is just the canvas key (like every other `# show ...` command), and
`skeleton`/`atlas` are required among the free-form `<key> <value>` construction props
(forwarded to [SpineOptions](/pixi-vn-spine/index/interfaces/SpineOptions)). An optional entrance transition can run the element in.

Call this once, near the start of your app (alongside e.g. `addBaseHashtagCommands`), before any
Ink content is parsed.

## Returns [#returns]

`void`

## Example [#example]

```ink
# show spine hero skeleton heroSkeleton atlas heroAtlas xAlign 0.5 yAlign 1 with dissolve duration 1
```


# Function: parseShowSpineTail() (/pixi-vn-spine/ink/functions/parseShowSpineTail)



\> **parseShowSpineTail**(`tail`): `object`

Defined in: [src/ink/spineHandler.ts:73](https://github.com/DRincs-Productions/pixi-vn-spine/blob/af3e1a792a130a16ec15e0361177d08e0fa2beaa/src/ink/spineHandler.ts#L73)

Splits the tail (everything after `<alias>`) of a `# show spine` command into its free-form
construction props and an optional entrance transition.

## Parameters [#parameters]

### tail [#tail]

`string`\[]

## Returns [#returns]

`object`

### propsList [#propslist]

\> **propsList**: `string`\[]

### transitionPropsList [#transitionpropslist]

\> **transitionPropsList**: `string`\[]

### transitionType? [#transitiontype]

\> `optional` **transitionType?**: `"dissolve"` | `"fade"` | `"movein"` | `"zoomin"` | `"pushin"`


# ink (/pixi-vn-spine/ink)



## Functions [#functions]

* [createSpineHandler](/pixi-vn-spine/ink/functions/createSpineHandler)
* [parseShowSpineTail](/pixi-vn-spine/ink/functions/parseShowSpineTail)


# @drincs/pixi-vn-spine (/pixi-vn-spine/modules)



## Modules [#modules]

* [index](/pixi-vn-spine/index)
* [ink](/pixi-vn-spine/ink)


# Class: CubismExpressionManager (/pixi-vn-live2d/core/classes/CubismExpressionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6138

Abstract expression manager.

## Emits [#emits]

[ExpressionManagerEvents](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)

## Extends [#extends]

* [`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)\<`CubismExpressionMotion`, `CubismSpec.Expression`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismExpressionManager**(`settings`, `options?`): `CubismExpressionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6142

#### Parameters [#parameters]

##### settings [#settings]

[`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

##### options? [#options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

#### Returns [#returns]

`CubismExpressionManager`

#### Overrides [#overrides]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`constructor`](/pixi-vn-live2d/core/classes/ExpressionManager#constructor)

## Properties [#properties]

### currentExpression [#currentexpression]

\> **currentExpression**: `CubismExpressionMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3812

Current Expression. This will not be overwritten by [ExpressionManager#defaultExpression](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression).

#### Inherited from [#inherited-from]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`currentExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#currentexpression)

***

### defaultExpression [#defaultexpression]

\> **defaultExpression**: `CubismExpressionMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3808

An empty Expression to reset all the expression parameters.

#### Inherited from [#inherited-from-1]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`defaultExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression)

***

### definitions [#definitions]

\> `readonly` **definitions**: `Expression`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6141

Expression definitions copied from ModelSettings.

#### Overrides [#overrides-1]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`definitions`](/pixi-vn-live2d/core/classes/ExpressionManager#definitions)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3820

Flags the instance has been destroyed.

#### Inherited from [#inherited-from-2]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`destroyed`](/pixi-vn-live2d/core/classes/ExpressionManager#destroyed)

***

### expressionDataType [#expressiondatatype]

\> `readonly` **expressionDataType**: `"arraybuffer"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6139

Indicates the content type used when loading expressions.

#### Default [#default]

```ts
"json"
```

#### Overrides [#overrides-2]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`expressionDataType`](/pixi-vn-live2d/core/classes/ExpressionManager#expressiondatatype)

***

### expressions [#expressions]

\> **expressions**: (`CubismExpressionMotion` | `null` | `undefined`)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3804

The Expressions. The structure is the same as [definitions](#definitions), initially there's only
an empty array, which means all expressions will be `undefined`. When an Expression has
been loaded, it'll fill the place in which it should be; when it fails to load,
the place will be filled with `null`.

#### Inherited from [#inherited-from-3]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`expressions`](/pixi-vn-live2d/core/classes/ExpressionManager#expressions)

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `CubismMotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6140

***

### reserveExpressionIndex [#reserveexpressionindex]

\> **reserveExpressionIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3816

The pending Expression.

#### Inherited from [#inherited-from-4]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`reserveExpressionIndex`](/pixi-vn-live2d/core/classes/ExpressionManager#reserveexpressionindex)

***

### settings [#settings-1]

\> `readonly` **settings**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3797

The ModelSettings reference.

#### Inherited from [#inherited-from-5]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`settings`](/pixi-vn-live2d/core/classes/ExpressionManager#settings)

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3789

Tag for logging.

#### Inherited from [#inherited-from-6]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`tag`](/pixi-vn-live2d/core/classes/ExpressionManager#tag)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-7]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`prefixed`](/pixi-vn-live2d/core/classes/ExpressionManager#prefixed)

## Methods [#methods]

### \_setExpression() [#_setexpression]

\> `protected` **\_setExpression**(`motion`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6147

Applies the Expression to the model.

#### Parameters [#parameters-1]

##### motion [#motion]

`CubismExpressionMotion`

#### Returns [#returns-1]

`number`

#### Overrides [#overrides-3]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`_setExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#_setexpression)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-2]

`this`

#### Inherited from [#inherited-from-8]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`addListener`](/pixi-vn-live2d/core/classes/ExpressionManager#addlistener)

***

### createDefaultExpression() [#createdefaultexpression]

\> `protected` **createDefaultExpression**(): `CubismExpressionMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6150

Creates the default expression instance used for resets.

#### Returns [#returns-3]

`CubismExpressionMotion`

#### Overrides [#overrides-4]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`createDefaultExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#createdefaultexpression)

***

### createExpression() [#createexpression]

\> **createExpression**(`data`, `_definition`): `CubismExpressionMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6146

Creates an Expression from the data.

#### Parameters [#parameters-3]

##### data [#data]

`ArrayBuffer`

Content of the expression file.

##### \_definition [#_definition]

`any`

#### Returns [#returns-4]

`CubismExpressionMotion`

The created Expression.

#### Overrides [#overrides-5]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`createExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#createexpression)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3872

Destroys the instance.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[ExpressionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#destroy)

#### Inherited from [#inherited-from-9]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`destroy`](/pixi-vn-live2d/core/classes/ExpressionManager#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-10]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`emit`](/pixi-vn-live2d/core/classes/ExpressionManager#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

#### Inherited from [#inherited-from-11]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`eventNames`](/pixi-vn-live2d/core/classes/ExpressionManager#eventnames)

***

### getExpressionFile() [#getexpressionfile]

\> **getExpressionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6145

Retrieves the expression's file path by its definition.

#### Parameters [#parameters-5]

##### definition [#definition]

`Expression`

#### Returns [#returns-8]

`string`

The file path extracted from given definition. Not resolved.

#### Overrides [#overrides-6]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`getExpressionFile`](/pixi-vn-live2d/core/classes/ExpressionManager#getexpressionfile)

***

### getExpressionIndex() [#getexpressionindex]

\> **getExpressionIndex**(`name`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6144

Retrieves the expression's index by its name.

#### Parameters [#parameters-6]

##### name [#name]

`string`

#### Returns [#returns-9]

`number`

The index. `-1` if not found.

#### Overrides [#overrides-7]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`getExpressionIndex`](/pixi-vn-live2d/core/classes/ExpressionManager#getexpressionindex)

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3825

Should be called in the constructor of derived class.

#### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-12]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`init`](/pixi-vn-live2d/core/classes/ExpressionManager#init)

***

### isFinished() [#isfinished]

\> **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6143

Checks if the expression playback has finished.

#### Returns [#returns-11]

`boolean`

#### Overrides [#overrides-8]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`isFinished`](/pixi-vn-live2d/core/classes/ExpressionManager#isfinished)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-7]

##### event [#event-2]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Returns [#returns-12]

`number`

#### Inherited from [#inherited-from-13]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`listenerCount`](/pixi-vn-live2d/core/classes/ExpressionManager#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-8]

##### event [#event-3]

`T`

#### Returns [#returns-13]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-14]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`listeners`](/pixi-vn-live2d/core/classes/ExpressionManager#listeners)

***

### loadExpression() [#loadexpression]

\> `protected` **loadExpression**(`index`): `Promise`\<`CubismExpressionMotion` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3838

Loads an Expression. Errors in this method will not be thrown,
but be emitted with an "expressionLoadError" event.

#### Parameters [#parameters-9]

##### index [#index]

`number`

Index of the expression in definitions.

#### Returns [#returns-14]

`Promise`\<`CubismExpressionMotion` | `undefined`>

Promise that resolves with the Expression, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[ExpressionManagerEvents.expressionLoaded](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaded)

#### Emits [#emits-3]

[ExpressionManagerEvents.expressionLoadError](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaderror)

#### Inherited from [#inherited-from-15]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`loadExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#loadexpression)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-10]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-15]

`this`

#### Inherited from [#inherited-from-16]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`off`](/pixi-vn-live2d/core/classes/ExpressionManager#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-11]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-16]

`this`

#### Inherited from [#inherited-from-17]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`on`](/pixi-vn-live2d/core/classes/ExpressionManager#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-12]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-17]

`this`

#### Inherited from [#inherited-from-18]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`once`](/pixi-vn-live2d/core/classes/ExpressionManager#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-13]

##### event? [#event-7]

keyof ExpressionManagerEvents\<never>

#### Returns [#returns-18]

`this`

#### Inherited from [#inherited-from-19]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`removeAllListeners`](/pixi-vn-live2d/core/classes/ExpressionManager#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-14]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-19]

`this`

#### Inherited from [#inherited-from-20]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`removeListener`](/pixi-vn-live2d/core/classes/ExpressionManager#removelistener)

***

### resetExpression() [#resetexpression]

\> **resetExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3852

Resets model's expression using [ExpressionManager#defaultExpression](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression).

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-21]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`resetExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#resetexpression)

***

### restoreExpression() [#restoreexpression]

\> **restoreExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3856

Restores model's expression to [currentExpression](#currentexpression).

#### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-22]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`restoreExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#restoreexpression)

***

### setExpression() [#setexpression]

\> **setExpression**(`index`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3862

Sets an Expression.

#### Parameters [#parameters-15]

##### index [#index-1]

`string` | `number`

Either the index, or the name of the expression.

#### Returns [#returns-22]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

#### Inherited from [#inherited-from-23]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`setExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#setexpression)

***

### setRandomExpression() [#setrandomexpression]

\> **setRandomExpression**(): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3848

Sets a random Expression that differs from current one.

#### Returns [#returns-23]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

#### Inherited from [#inherited-from-24]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`setRandomExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#setrandomexpression)

***

### stopAllExpressions() [#stopallexpressions]

\> `protected` **stopAllExpressions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6148

Cancels expression playback.

#### Returns [#returns-24]

`void`

#### Overrides [#overrides-9]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`stopAllExpressions`](/pixi-vn-live2d/core/classes/ExpressionManager#stopallexpressions)

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3867

Updates parameters of the core model.

#### Parameters [#parameters-16]

##### model [#model]

`object`

##### now [#now]

`number`

#### Returns [#returns-25]

`boolean`

True if the parameters are actually updated.

#### Inherited from [#inherited-from-25]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`update`](/pixi-vn-live2d/core/classes/ExpressionManager#update)

***

### updateParameters() [#updateparameters]

\> `protected` **updateParameters**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6149

Updates parameters of the core model.

#### Parameters [#parameters-17]

##### model [#model-1]

`CubismModel`

##### now [#now-1]

`number`

#### Returns [#returns-26]

`boolean`

True if the parameters are actually updated.

#### Overrides [#overrides-10]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`updateParameters`](/pixi-vn-live2d/core/classes/ExpressionManager#updateparameters)


# Class: CubismInternalModel (/pixi-vn-live2d/core/classes/CubismInternalModel)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6902

A wrapper that manages the states of a Live2D core model, and delegates all operations to it.

## Emits [#emits]

[InternalModelEvents](/pixi-vn-live2d/core/interfaces/InternalModelEvents)

## Extends [#extends]

* [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismInternalModel**(`coreModel`, `settings`, `options?`): `CubismInternalModel`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6931

#### Parameters [#parameters]

##### coreModel [#coremodel]

`CubismModel`

##### settings [#settings]

[`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

##### options? [#options]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

#### Returns [#returns]

`CubismInternalModel`

#### Overrides [#overrides]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`constructor`](/pixi-vn-live2d/core/classes/InternalModel#constructor)

## Properties [#properties]

### breath [#breath]

\> **breath**: `CubismBreath`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6909

***

### coreModel [#coremodel-1]

\> **coreModel**: `CubismModel`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6905

The managed Live2D core model.

#### Overrides [#overrides-1]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`coreModel`](/pixi-vn-live2d/core/classes/InternalModel#coremodel)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3203

Flags this instance has been destroyed.

#### Inherited from [#inherited-from]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`destroyed`](/pixi-vn-live2d/core/classes/InternalModel#destroyed)

***

### drawingMatrix [#drawingmatrix]

\> **drawingMatrix**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3182

The final matrix to draw the model.

#### Inherited from [#inherited-from-1]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`drawingMatrix`](/pixi-vn-live2d/core/classes/InternalModel#drawingmatrix)

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `CubismEyeBlink`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6910

***

### focusController [#focuscontroller]

\> **focusController**: [`FocusController`](/pixi-vn-live2d/core/classes/FocusController)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3152

#### Inherited from [#inherited-from-2]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`focusController`](/pixi-vn-live2d/core/classes/InternalModel#focuscontroller)

***

### height [#height]

\> `readonly` **height**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3174

Canvas height of the model, scaled by the `height` of the model's layout.

#### Inherited from [#inherited-from-3]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`height`](/pixi-vn-live2d/core/classes/InternalModel#height)

***

### hitAreas [#hitareas]

\> **hitAreas**: `Record`\<`string`, [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3186

The hit area definitions, keyed by their names.

#### Inherited from [#inherited-from-4]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`hitAreas`](/pixi-vn-live2d/core/classes/InternalModel#hitareas)

***

### idParamAngleX [#idparamanglex]

\> **idParamAngleX**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6915

***

### idParamAngleY [#idparamangley]

\> **idParamAngleY**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6916

***

### idParamAngleZ [#idparamanglez]

\> **idParamAngleZ**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6917

***

### idParamBodyAngleX [#idparambodyanglex]

\> **idParamBodyAngleX**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6920

***

### idParamBreath [#idparambreath]

\> **idParamBreath**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6921

***

### idParamEyeBallX [#idparameyeballx]

\> **idParamEyeBallX**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6918

***

### idParamEyeBallY [#idparameyebally]

\> **idParamEyeBallY**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6919

***

### idParamMouthForm [#idparammouthform]

\> **idParamMouthForm**: `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6922

***

### lipSync [#lipsync]

\> **lipSync**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6908

***

### localTransform [#localtransform]

\> **localTransform**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3178

Local transformation, calculated from the model's layout.

#### Inherited from [#inherited-from-5]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`localTransform`](/pixi-vn-live2d/core/classes/InternalModel#localtransform)

***

### modelTransform [#modeltransform]

\> `protected` **modelTransform**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6930

Matrix that scales by [pixelsPerUnit](#pixelsperunit), and moves the origin from top-left to center.

***

### motionManager [#motionmanager]

\> **motionManager**: [`CubismMotionManager`](/pixi-vn-live2d/core/classes/CubismMotionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6906

#### Overrides [#overrides-2]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`motionManager`](/pixi-vn-live2d/core/classes/InternalModel#motionmanager)

***

### options [#options-1]

\> **options**: [`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6904

#### Overrides [#overrides-3]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`options`](/pixi-vn-live2d/core/classes/InternalModel#options)

***

### originalHeight [#originalheight]

\> `readonly` **originalHeight**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3166

Original canvas height of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

#### Inherited from [#inherited-from-6]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`originalHeight`](/pixi-vn-live2d/core/classes/InternalModel#originalheight)

***

### originalWidth [#originalwidth]

\> `readonly` **originalWidth**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3161

Original canvas width of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

#### Inherited from [#inherited-from-7]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`originalWidth`](/pixi-vn-live2d/core/classes/InternalModel#originalwidth)

***

### parallelMotionManager [#parallelmotionmanager]

\> **parallelMotionManager**: [`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6907

#### Overrides [#overrides-4]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`parallelMotionManager`](/pixi-vn-live2d/core/classes/InternalModel#parallelmotionmanager)

***

### physics? [#physics]

\> `optional` **physics?**: `CubismPhysics`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6912

#### Overrides [#overrides-5]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`physics`](/pixi-vn-live2d/core/classes/InternalModel#physics)

***

### pixelsPerUnit [#pixelsperunit]

\> `readonly` **pixelsPerUnit**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6926

The model's internal scale, defined in the moc3 file.

***

### pose? [#pose]

\> `optional` **pose?**: `CubismPose`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6911

#### Overrides [#overrides-6]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`pose`](/pixi-vn-live2d/core/classes/InternalModel#pose)

***

### renderer [#renderer]

\> **renderer**: `CubismRenderer_WebGL`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6913

***

### settings [#settings-1]

\> **settings**: [`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6903

#### Overrides [#overrides-7]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`settings`](/pixi-vn-live2d/core/classes/InternalModel#settings)

***

### textureFlipY [#textureflipy]

\> **textureFlipY**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3190

Flags whether `gl.UNPACK_FLIP_Y_WEBGL` should be enabled when binding the textures.

#### Inherited from [#inherited-from-8]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`textureFlipY`](/pixi-vn-live2d/core/classes/InternalModel#textureflipy)

***

### viewport [#viewport]

\> **viewport**: \[`number`, `number`, `number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3194

WebGL viewport when drawing the model. The format is `[x, y, width, height]`.

#### Inherited from [#inherited-from-9]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`viewport`](/pixi-vn-live2d/core/classes/InternalModel#viewport)

***

### width [#width]

\> `readonly` **width**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3170

Canvas width of the model, scaled by the `width` of the model's layout.

#### Inherited from [#inherited-from-10]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`width`](/pixi-vn-live2d/core/classes/InternalModel#width)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-11]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`prefixed`](/pixi-vn-live2d/core/classes/InternalModel#prefixed)

## Methods [#methods]

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-1]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-1]

`this`

#### Inherited from [#inherited-from-12]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`addListener`](/pixi-vn-live2d/core/classes/InternalModel#addlistener)

***

### bindTexture() [#bindtexture]

\> **bindTexture**(`index`, `texture`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6941

Binds a texture to the model. The index must be the same as that of this texture
in the [ModelSettings.textures](/pixi-vn-live2d/core/classes/ModelSettings#textures) array.

#### Parameters [#parameters-2]

##### index [#index]

`number`

##### texture [#texture]

`WebGLTexture`

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-8]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`bindTexture`](/pixi-vn-live2d/core/classes/InternalModel#bindtexture)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6953

Destroys the model and all related resources.

#### Returns [#returns-3]

`void`

#### Emits [#emits-1]

\`InternalModelEvents.destroy\` | destroy

#### Overrides [#overrides-9]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`destroy`](/pixi-vn-live2d/core/classes/InternalModel#destroy)

***

### draw() [#draw]

\> **draw**(`gl`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6951

Draws the model.

#### Parameters [#parameters-3]

##### gl [#gl]

`WebGLRenderingContext`

#### Returns [#returns-4]

`void`

#### Overrides [#overrides-10]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`draw`](/pixi-vn-live2d/core/classes/InternalModel#draw)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-13]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`emit`](/pixi-vn-live2d/core/classes/InternalModel#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-6]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-14]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`eventNames`](/pixi-vn-live2d/core/classes/InternalModel#eventnames)

***

### extendParallelMotionManager() [#extendparallelmotionmanager]

\> **extendParallelMotionManager**(`managerCount`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6952

Add parallel motion manager.

#### Parameters [#parameters-5]

##### managerCount [#managercount]

`number`

Count of parallel motion managers.

#### Returns [#returns-7]

`void`

#### Overrides [#overrides-11]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`extendParallelMotionManager`](/pixi-vn-live2d/core/classes/InternalModel#extendparallelmotionmanager)

***

### getDrawableBounds() [#getdrawablebounds]

\> **getDrawableBounds**(`index`, `bounds?`): `Bounds`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3237

Gets a drawable's bounds.

#### Parameters [#parameters-6]

##### index [#index-1]

`number`

Index of the drawable.

##### bounds? [#bounds]

`Bounds`

Object to store the output values.

#### Returns [#returns-8]

`Bounds`

The bounds in model canvas space.

#### Inherited from [#inherited-from-15]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableBounds`](/pixi-vn-live2d/core/classes/InternalModel#getdrawablebounds)

***

### getDrawableIDs() [#getdrawableids]

\> **getDrawableIDs**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6943

Gets all the drawables' IDs.

#### Returns [#returns-9]

`string`\[]

IDs.

#### Overrides [#overrides-12]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableIDs`](/pixi-vn-live2d/core/classes/InternalModel#getdrawableids)

***

### getDrawableIndex() [#getdrawableindex]

\> **getDrawableIndex**(`id`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6944

Finds the index of a drawable by its ID.

#### Parameters [#parameters-7]

##### id [#id]

`string`

#### Returns [#returns-10]

`number`

The index.

#### Overrides [#overrides-13]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableIndex`](/pixi-vn-live2d/core/classes/InternalModel#getdrawableindex)

***

### getDrawableVertices() [#getdrawablevertices]

\> **getDrawableVertices**(`drawIndex`): `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6945

Gets a drawable's vertices.

#### Parameters [#parameters-8]

##### drawIndex [#drawindex]

`string` | `number`

#### Returns [#returns-11]

`Float32Array`

#### Throws [#throws]

Error when the drawable cannot be found.

#### Overrides [#overrides-14]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableVertices`](/pixi-vn-live2d/core/classes/InternalModel#getdrawablevertices)

***

### getHitAreaDefs() [#gethitareadefs]

\> `protected` **getHitAreaDefs**(): [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6942

Gets all the hit area definitions.

#### Returns [#returns-12]

[`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Normalized definitions.

#### Overrides [#overrides-15]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getHitAreaDefs`](/pixi-vn-live2d/core/classes/InternalModel#gethitareadefs)

***

### getIdSafe() [#getidsafe]

\> `protected` **getIdSafe**(`id`): `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6933

#### Parameters [#parameters-9]

##### id [#id-1]

`string` | `undefined`

#### Returns [#returns-13]

`CubismId`

***

### getLayout() [#getlayout]

\> `protected` **getLayout**(): [`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6938

Gets the layout definition.

#### Returns [#returns-14]

[`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Normalized definition.

#### Overrides [#overrides-16]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getLayout`](/pixi-vn-live2d/core/classes/InternalModel#getlayout)

***

### getSize() [#getsize]

\> `protected` **getSize**(): \[`number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6934

Gets the model's original canvas size.

#### Returns [#returns-15]

\[`number`, `number`]

`[width, height]`

#### Overrides [#overrides-17]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getSize`](/pixi-vn-live2d/core/classes/InternalModel#getsize)

***

### hitTest() [#hittest]

\> **hitTest**(`x`, `y`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3222

Hit-test on the model.

#### Parameters [#parameters-10]

##### x [#x]

`number`

Position in model canvas.

##### y [#y]

`number`

Position in model canvas.

#### Returns [#returns-16]

`string`\[]

The names of the *hit* hit areas. Can be empty if none is hit.

#### Inherited from [#inherited-from-16]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`hitTest`](/pixi-vn-live2d/core/classes/InternalModel#hittest)

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6932

Should be called in the constructor of derived class.

#### Returns [#returns-17]

`void`

#### Overrides [#overrides-18]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`init`](/pixi-vn-live2d/core/classes/InternalModel#init)

***

### isHit() [#ishit]

\> **isHit**(`hitAreaName`, `x`, `y`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3230

Hit-test for a single hit area.

#### Parameters [#parameters-11]

##### hitAreaName [#hitareaname]

`string`

The hit area's name.

##### x [#x-1]

`number`

Position in model canvas.

##### y [#y-1]

`number`

Position in model canvas.

#### Returns [#returns-18]

`boolean`

True if hit.

#### Inherited from [#inherited-from-17]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`isHit`](/pixi-vn-live2d/core/classes/InternalModel#ishit)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-12]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-19]

`number`

#### Inherited from [#inherited-from-18]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`listenerCount`](/pixi-vn-live2d/core/classes/InternalModel#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-13]

##### event [#event-3]

`T`

#### Returns [#returns-20]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-19]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`listeners`](/pixi-vn-live2d/core/classes/InternalModel#listeners)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-14]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-20]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`off`](/pixi-vn-live2d/core/classes/InternalModel#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-15]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-21]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`on`](/pixi-vn-live2d/core/classes/InternalModel#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-16]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-22]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`once`](/pixi-vn-live2d/core/classes/InternalModel#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-17]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-23]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`removeAllListeners`](/pixi-vn-live2d/core/classes/InternalModel#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-18]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-25]

`this`

#### Inherited from [#inherited-from-24]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`removeListener`](/pixi-vn-live2d/core/classes/InternalModel#removelistener)

***

### setupHitAreas() [#setuphitareas]

\> `protected` **setupHitAreas**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3215

Sets up the hit areas by their definitions in settings.

#### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-25]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`setupHitAreas`](/pixi-vn-live2d/core/classes/InternalModel#setuphitareas)

***

### setupLayout() [#setuplayout]

\> `protected` **setupLayout**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6939

Sets up the model's size and local transform by the model's layout.

#### Returns [#returns-27]

`void`

#### Overrides [#overrides-19]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`setupLayout`](/pixi-vn-live2d/core/classes/InternalModel#setuplayout)

***

### update() [#update]

\> **update**(`dt`, `now`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6947

Updates the model's parameters.

#### Parameters [#parameters-19]

##### dt [#dt]

`number`

Elapsed time in milliseconds from last frame.

##### now [#now]

`number`

#### Returns [#returns-28]

`void`

#### Overrides [#overrides-20]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`update`](/pixi-vn-live2d/core/classes/InternalModel#update)

***

### updateFacialEmotion() [#updatefacialemotion]

\> **updateFacialEmotion**(`mouthForm`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6949

#### Parameters [#parameters-20]

##### mouthForm [#mouthform]

`number`

#### Returns [#returns-29]

`void`

***

### updateFocus() [#updatefocus]

\> **updateFocus**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6948

#### Returns [#returns-30]

`void`

***

### updateMotions() [#updatemotions]

\> `protected` **updateMotions**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3270

Updates all active motions for the model and emits lifecycle events.

This method coordinates the update cycle for both primary and parallel motion managers,
ensuring all animations are synchronized with the current timestamp. It emits events
before and after the update process, allowing external listeners to hook into the motion
lifecycle. The return value indicates whether any motion was actively updated during this cycle.

#### Parameters [#parameters-21]

##### model [#model]

`object`

The model instance to apply motion updates to.

##### now [#now-1]

`number`

The current timestamp (in milliseconds) used to calculate motion progress.

#### Returns [#returns-31]

`boolean`

Returns `true` if any motion (primary or parallel) was updated; `false` otherwise.

#### Emits [#emits-2]

beforeMotionUpdate - Triggered before any motion updates are processed.

#### Emits [#emits-3]

afterMotionUpdate - Triggered after all motion updates are completed.

#### Inherited from [#inherited-from-26]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateMotions`](/pixi-vn-live2d/core/classes/InternalModel#updatemotions)

***

### updateNaturalMovements() [#updatenaturalmovements]

\> **updateNaturalMovements**(`dt`, `_now`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6950

#### Parameters [#parameters-22]

##### dt [#dt-1]

`number`

##### \_now [#_now]

`number`

#### Returns [#returns-32]

`void`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`transform`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6946

Updates the model's transform.

#### Parameters [#parameters-23]

##### transform [#transform]

`Matrix`

The world transform.

#### Returns [#returns-33]

`void`

#### Overrides [#overrides-21]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateTransform`](/pixi-vn-live2d/core/classes/InternalModel#updatetransform)

***

### updateWebGLContext() [#updatewebglcontext]

\> **updateWebGLContext**(`gl`, `glContextID`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6940

Updates WebGL context bound to this model.

#### Parameters [#parameters-24]

##### gl [#gl-1]

`WebGLRenderingContext`

WebGL context.

##### glContextID [#glcontextid]

`number`

Unique ID for given WebGL context.

#### Returns [#returns-34]

`void`

#### Overrides [#overrides-22]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateWebGLContext`](/pixi-vn-live2d/core/classes/InternalModel#updatewebglcontext)


# Class: CubismLegacyExpressionManager (/pixi-vn-live2d/core/classes/CubismLegacyExpressionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5017

Abstract expression manager.

## Emits [#emits]

[ExpressionManagerEvents](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)

## Extends [#extends]

* [`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)\<[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismLegacyExpressionManager**(`settings`, `options?`): `CubismLegacyExpressionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5021

#### Parameters [#parameters]

##### settings [#settings]

[`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)

##### options? [#options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

#### Returns [#returns]

`CubismLegacyExpressionManager`

#### Overrides [#overrides]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`constructor`](/pixi-vn-live2d/core/classes/ExpressionManager#constructor)

## Properties [#properties]

### currentExpression [#currentexpression]

\> **currentExpression**: [`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3812

Current Expression. This will not be overwritten by [ExpressionManager#defaultExpression](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression).

#### Inherited from [#inherited-from]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`currentExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#currentexpression)

***

### defaultExpression [#defaultexpression]

\> **defaultExpression**: [`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3808

An empty Expression to reset all the expression parameters.

#### Inherited from [#inherited-from-1]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`defaultExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression)

***

### definitions [#definitions]

\> `readonly` **definitions**: [`Expression`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5019

Expression definitions copied from ModelSettings.

#### Overrides [#overrides-1]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`definitions`](/pixi-vn-live2d/core/classes/ExpressionManager#definitions)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3820

Flags the instance has been destroyed.

#### Inherited from [#inherited-from-2]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`destroyed`](/pixi-vn-live2d/core/classes/ExpressionManager#destroyed)

***

### expressionDataType [#expressiondatatype]

\> `readonly` **expressionDataType**: `XMLHttpRequestResponseType`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3785

Indicates the content type used when loading expressions.

#### Default [#default]

```ts
"json"
```

#### Inherited from [#inherited-from-3]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`expressionDataType`](/pixi-vn-live2d/core/classes/ExpressionManager#expressiondatatype)

***

### expressions [#expressions]

\> **expressions**: ([`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression) | `null` | `undefined`)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3804

The Expressions. The structure is the same as [definitions](#definitions), initially there's only
an empty array, which means all expressions will be `undefined`. When an Expression has
been loaded, it'll fill the place in which it should be; when it fails to load,
the place will be filled with `null`.

#### Inherited from [#inherited-from-4]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`expressions`](/pixi-vn-live2d/core/classes/ExpressionManager#expressions)

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `MotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5018

***

### reserveExpressionIndex [#reserveexpressionindex]

\> **reserveExpressionIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3816

The pending Expression.

#### Inherited from [#inherited-from-5]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`reserveExpressionIndex`](/pixi-vn-live2d/core/classes/ExpressionManager#reserveexpressionindex)

***

### settings [#settings-1]

\> `readonly` **settings**: [`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5020

The ModelSettings reference.

#### Overrides [#overrides-2]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`settings`](/pixi-vn-live2d/core/classes/ExpressionManager#settings)

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3789

Tag for logging.

#### Inherited from [#inherited-from-6]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`tag`](/pixi-vn-live2d/core/classes/ExpressionManager#tag)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-7]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`prefixed`](/pixi-vn-live2d/core/classes/ExpressionManager#prefixed)

## Methods [#methods]

### \_setExpression() [#_setexpression]

\> `protected` **\_setExpression**(`motion`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5026

Applies the Expression to the model.

#### Parameters [#parameters-1]

##### motion [#motion]

[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

#### Returns [#returns-1]

`number`

#### Overrides [#overrides-3]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`_setExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#_setexpression)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-2]

`this`

#### Inherited from [#inherited-from-8]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`addListener`](/pixi-vn-live2d/core/classes/ExpressionManager#addlistener)

***

### createDefaultExpression() [#createdefaultexpression]

\> `protected` **createDefaultExpression**(): [`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3829

Creates the default expression instance used for resets.

#### Returns [#returns-3]

[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

#### Inherited from [#inherited-from-9]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`createDefaultExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#createdefaultexpression)

***

### createExpression() [#createexpression]

\> **createExpression**(`data`, `_definition`): [`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5025

Creates an Expression from the data.

#### Parameters [#parameters-3]

##### data [#data]

`object`

Content of the expression file.

##### \_definition [#_definition]

[`Expression`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression) | `undefined`

#### Returns [#returns-4]

[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression)

The created Expression.

#### Overrides [#overrides-4]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`createExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#createexpression)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3872

Destroys the instance.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[ExpressionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#destroy)

#### Inherited from [#inherited-from-10]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`destroy`](/pixi-vn-live2d/core/classes/ExpressionManager#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-11]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`emit`](/pixi-vn-live2d/core/classes/ExpressionManager#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

#### Inherited from [#inherited-from-12]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`eventNames`](/pixi-vn-live2d/core/classes/ExpressionManager#eventnames)

***

### getExpressionFile() [#getexpressionfile]

\> **getExpressionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5024

Retrieves the expression's file path by its definition.

#### Parameters [#parameters-5]

##### definition [#definition]

[`Expression`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)

#### Returns [#returns-8]

`string`

The file path extracted from given definition. Not resolved.

#### Overrides [#overrides-5]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`getExpressionFile`](/pixi-vn-live2d/core/classes/ExpressionManager#getexpressionfile)

***

### getExpressionIndex() [#getexpressionindex]

\> **getExpressionIndex**(`name`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5023

Retrieves the expression's index by its name.

#### Parameters [#parameters-6]

##### name [#name]

`string`

#### Returns [#returns-9]

`number`

The index. `-1` if not found.

#### Overrides [#overrides-6]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`getExpressionIndex`](/pixi-vn-live2d/core/classes/ExpressionManager#getexpressionindex)

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3825

Should be called in the constructor of derived class.

#### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-13]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`init`](/pixi-vn-live2d/core/classes/ExpressionManager#init)

***

### isFinished() [#isfinished]

\> **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5022

Checks if the expression playback has finished.

#### Returns [#returns-11]

`boolean`

#### Overrides [#overrides-7]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`isFinished`](/pixi-vn-live2d/core/classes/ExpressionManager#isfinished)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-7]

##### event [#event-2]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Returns [#returns-12]

`number`

#### Inherited from [#inherited-from-14]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`listenerCount`](/pixi-vn-live2d/core/classes/ExpressionManager#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-8]

##### event [#event-3]

`T`

#### Returns [#returns-13]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-15]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`listeners`](/pixi-vn-live2d/core/classes/ExpressionManager#listeners)

***

### loadExpression() [#loadexpression]

\> `protected` **loadExpression**(`index`): `Promise`\<[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression) | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3838

Loads an Expression. Errors in this method will not be thrown,
but be emitted with an "expressionLoadError" event.

#### Parameters [#parameters-9]

##### index [#index]

`number`

Index of the expression in definitions.

#### Returns [#returns-14]

`Promise`\<[`Live2DExpression`](/pixi-vn-live2d/core/classes/Live2DExpression) | `undefined`>

Promise that resolves with the Expression, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[ExpressionManagerEvents.expressionLoaded](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaded)

#### Emits [#emits-3]

[ExpressionManagerEvents.expressionLoadError](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaderror)

#### Inherited from [#inherited-from-16]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`loadExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#loadexpression)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-10]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-15]

`this`

#### Inherited from [#inherited-from-17]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`off`](/pixi-vn-live2d/core/classes/ExpressionManager#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-11]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-16]

`this`

#### Inherited from [#inherited-from-18]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`on`](/pixi-vn-live2d/core/classes/ExpressionManager#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-12]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-17]

`this`

#### Inherited from [#inherited-from-19]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`once`](/pixi-vn-live2d/core/classes/ExpressionManager#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-13]

##### event? [#event-7]

keyof ExpressionManagerEvents\<never>

#### Returns [#returns-18]

`this`

#### Inherited from [#inherited-from-20]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`removeAllListeners`](/pixi-vn-live2d/core/classes/ExpressionManager#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-14]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-19]

`this`

#### Inherited from [#inherited-from-21]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`removeListener`](/pixi-vn-live2d/core/classes/ExpressionManager#removelistener)

***

### resetExpression() [#resetexpression]

\> **resetExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3852

Resets model's expression using [ExpressionManager#defaultExpression](/pixi-vn-live2d/core/classes/ExpressionManager#defaultexpression).

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-22]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`resetExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#resetexpression)

***

### restoreExpression() [#restoreexpression]

\> **restoreExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3856

Restores model's expression to [currentExpression](#currentexpression).

#### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-23]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`restoreExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#restoreexpression)

***

### setExpression() [#setexpression]

\> **setExpression**(`index`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3862

Sets an Expression.

#### Parameters [#parameters-15]

##### index [#index-1]

`string` | `number`

Either the index, or the name of the expression.

#### Returns [#returns-22]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

#### Inherited from [#inherited-from-24]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`setExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#setexpression)

***

### setRandomExpression() [#setrandomexpression]

\> **setRandomExpression**(): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3848

Sets a random Expression that differs from current one.

#### Returns [#returns-23]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

#### Inherited from [#inherited-from-25]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`setRandomExpression`](/pixi-vn-live2d/core/classes/ExpressionManager#setrandomexpression)

***

### stopAllExpressions() [#stopallexpressions]

\> `protected` **stopAllExpressions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5027

Cancels expression playback.

#### Returns [#returns-24]

`void`

#### Overrides [#overrides-8]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`stopAllExpressions`](/pixi-vn-live2d/core/classes/ExpressionManager#stopallexpressions)

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3867

Updates parameters of the core model.

#### Parameters [#parameters-16]

##### model [#model]

`object`

##### now [#now]

`number`

#### Returns [#returns-25]

`boolean`

True if the parameters are actually updated.

#### Inherited from [#inherited-from-26]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`update`](/pixi-vn-live2d/core/classes/ExpressionManager#update)

***

### updateParameters() [#updateparameters]

\> `protected` **updateParameters**(`model`, `_dt`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5028

Updates parameters of the core model.

#### Parameters [#parameters-17]

##### model [#model-1]

`Live2DModelWebGL`

##### \_dt [#_dt]

`number`

#### Returns [#returns-26]

`boolean`

True if the parameters are actually updated.

#### Overrides [#overrides-9]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager).[`updateParameters`](/pixi-vn-live2d/core/classes/ExpressionManager#updateparameters)


# Class: CubismLegacyInternalModel (/pixi-vn-live2d/core/classes/CubismLegacyInternalModel)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5112

A wrapper that manages the states of a Live2D core model, and delegates all operations to it.

## Emits [#emits]

[InternalModelEvents](/pixi-vn-live2d/core/interfaces/InternalModelEvents)

## Extends [#extends]

* [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismLegacyInternalModel**(`coreModel`, `settings`, `options?`): `CubismLegacyInternalModel`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5141

#### Parameters [#parameters]

##### coreModel [#coremodel]

`Live2DModelWebGL`

##### settings [#settings]

[`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)

##### options? [#options]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

#### Returns [#returns]

`CubismLegacyInternalModel`

#### Overrides [#overrides]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`constructor`](/pixi-vn-live2d/core/classes/InternalModel#constructor)

## Properties [#properties]

### angleXParamIndex [#anglexparamindex]

\> **angleXParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5123

***

### angleYParamIndex [#angleyparamindex]

\> **angleYParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5124

***

### angleZParamIndex [#anglezparamindex]

\> **angleZParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5125

***

### bodyAngleXParamIndex [#bodyanglexparamindex]

\> **bodyAngleXParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5126

***

### breathParamIndex [#breathparamindex]

\> **breathParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5127

***

### coreModel [#coremodel-1]

\> **coreModel**: `Live2DModelWebGL`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5115

The managed Live2D core model.

#### Overrides [#overrides-1]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`coreModel`](/pixi-vn-live2d/core/classes/InternalModel#coremodel)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3203

Flags this instance has been destroyed.

#### Inherited from [#inherited-from]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`destroyed`](/pixi-vn-live2d/core/classes/InternalModel#destroyed)

***

### disableCulling [#disableculling]

\> **disableCulling**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5138

If true, the face culling will always be disabled when drawing the model,
regardless of the model's internal flags.

***

### drawDataCount [#drawdatacount]

\> **drawDataCount**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5133

Number of the drawables in this model.

***

### drawingMatrix [#drawingmatrix]

\> **drawingMatrix**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3182

The final matrix to draw the model.

#### Inherited from [#inherited-from-1]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`drawingMatrix`](/pixi-vn-live2d/core/classes/InternalModel#drawingmatrix)

***

### eyeballXParamIndex [#eyeballxparamindex]

\> **eyeballXParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5121

***

### eyeballYParamIndex [#eyeballyparamindex]

\> **eyeballYParamIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5122

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: [`Live2DEyeBlink`](/pixi-vn-live2d/core/classes/Live2DEyeBlink)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5118

***

### focusController [#focuscontroller]

\> **focusController**: [`FocusController`](/pixi-vn-live2d/core/classes/FocusController)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3152

#### Inherited from [#inherited-from-2]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`focusController`](/pixi-vn-live2d/core/classes/InternalModel#focuscontroller)

***

### height [#height]

\> `readonly` **height**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3174

Canvas height of the model, scaled by the `height` of the model's layout.

#### Inherited from [#inherited-from-3]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`height`](/pixi-vn-live2d/core/classes/InternalModel#height)

***

### hitAreas [#hitareas]

\> **hitAreas**: `Record`\<`string`, [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3186

The hit area definitions, keyed by their names.

#### Inherited from [#inherited-from-4]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`hitAreas`](/pixi-vn-live2d/core/classes/InternalModel#hitareas)

***

### lipSync [#lipsync]

\> **lipSync**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5129

***

### localTransform [#localtransform]

\> **localTransform**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3178

Local transformation, calculated from the model's layout.

#### Inherited from [#inherited-from-5]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`localTransform`](/pixi-vn-live2d/core/classes/InternalModel#localtransform)

***

### motionManager [#motionmanager]

\> **motionManager**: [`CubismLegacyMotionManager`](/pixi-vn-live2d/core/classes/CubismLegacyMotionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5116

#### Overrides [#overrides-2]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`motionManager`](/pixi-vn-live2d/core/classes/InternalModel#motionmanager)

***

### options [#options-1]

\> **options**: [`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5114

#### Overrides [#overrides-3]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`options`](/pixi-vn-live2d/core/classes/InternalModel#options)

***

### originalHeight [#originalheight]

\> `readonly` **originalHeight**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3166

Original canvas height of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

#### Inherited from [#inherited-from-6]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`originalHeight`](/pixi-vn-live2d/core/classes/InternalModel#originalheight)

***

### originalWidth [#originalwidth]

\> `readonly` **originalWidth**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3161

Original canvas width of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

#### Inherited from [#inherited-from-7]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`originalWidth`](/pixi-vn-live2d/core/classes/InternalModel#originalwidth)

***

### parallelMotionManager [#parallelmotionmanager]

\> **parallelMotionManager**: [`CubismLegacyParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismLegacyParallelMotionManager)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5117

#### Overrides [#overrides-4]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`parallelMotionManager`](/pixi-vn-live2d/core/classes/InternalModel#parallelmotionmanager)

***

### physics? [#physics]

\> `optional` **physics?**: [`Live2DPhysics`](/pixi-vn-live2d/core/classes/Live2DPhysics)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5119

#### Overrides [#overrides-5]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`physics`](/pixi-vn-live2d/core/classes/InternalModel#physics)

***

### pose? [#pose]

\> `optional` **pose?**: [`Live2DPose`](/pixi-vn-live2d/core/classes/Live2DPose)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5120

#### Overrides [#overrides-6]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`pose`](/pixi-vn-live2d/core/classes/InternalModel#pose)

***

### settings [#settings-1]

\> **settings**: [`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5113

#### Overrides [#overrides-7]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`settings`](/pixi-vn-live2d/core/classes/InternalModel#settings)

***

### textureFlipY [#textureflipy]

\> **textureFlipY**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5128

Flags whether `gl.UNPACK_FLIP_Y_WEBGL` should be enabled when binding the textures.

#### Overrides [#overrides-8]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`textureFlipY`](/pixi-vn-live2d/core/classes/InternalModel#textureflipy)

***

### viewport [#viewport]

\> **viewport**: \[`number`, `number`, `number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3194

WebGL viewport when drawing the model. The format is `[x, y, width, height]`.

#### Inherited from [#inherited-from-8]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`viewport`](/pixi-vn-live2d/core/classes/InternalModel#viewport)

***

### width [#width]

\> `readonly` **width**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3170

Canvas width of the model, scaled by the `width` of the model's layout.

#### Inherited from [#inherited-from-9]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`width`](/pixi-vn-live2d/core/classes/InternalModel#width)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-10]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`prefixed`](/pixi-vn-live2d/core/classes/InternalModel#prefixed)

## Methods [#methods]

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-1]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-1]

`this`

#### Inherited from [#inherited-from-11]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`addListener`](/pixi-vn-live2d/core/classes/InternalModel#addlistener)

***

### bindTexture() [#bindtexture]

\> **bindTexture**(`index`, `texture`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5149

Binds a texture to the model. The index must be the same as that of this texture
in the [ModelSettings.textures](/pixi-vn-live2d/core/classes/ModelSettings#textures) array.

#### Parameters [#parameters-2]

##### index [#index]

`number`

##### texture [#texture]

`WebGLTexture`

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-9]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`bindTexture`](/pixi-vn-live2d/core/classes/InternalModel#bindtexture)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5160

Destroys the model and all related resources.

#### Returns [#returns-3]

`void`

#### Emits [#emits-1]

\`InternalModelEvents.destroy\` | destroy

#### Overrides [#overrides-10]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`destroy`](/pixi-vn-live2d/core/classes/InternalModel#destroy)

***

### draw() [#draw]

\> **draw**(`gl`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5158

Draws the model.

#### Parameters [#parameters-3]

##### gl [#gl]

`WebGLRenderingContext`

#### Returns [#returns-4]

`void`

#### Overrides [#overrides-11]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`draw`](/pixi-vn-live2d/core/classes/InternalModel#draw)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-12]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`emit`](/pixi-vn-live2d/core/classes/InternalModel#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-6]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-13]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`eventNames`](/pixi-vn-live2d/core/classes/InternalModel#eventnames)

***

### extendParallelMotionManager() [#extendparallelmotionmanager]

\> **extendParallelMotionManager**(`managerCount`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5159

Add parallel motion manager.

#### Parameters [#parameters-5]

##### managerCount [#managercount]

`number`

Count of parallel motion managers.

#### Returns [#returns-7]

`void`

#### Overrides [#overrides-12]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`extendParallelMotionManager`](/pixi-vn-live2d/core/classes/InternalModel#extendparallelmotionmanager)

***

### getDrawableBounds() [#getdrawablebounds]

\> **getDrawableBounds**(`index`, `bounds?`): `Bounds`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3237

Gets a drawable's bounds.

#### Parameters [#parameters-6]

##### index [#index-1]

`number`

Index of the drawable.

##### bounds? [#bounds]

`Bounds`

Object to store the output values.

#### Returns [#returns-8]

`Bounds`

The bounds in model canvas space.

#### Inherited from [#inherited-from-14]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableBounds`](/pixi-vn-live2d/core/classes/InternalModel#getdrawablebounds)

***

### getDrawableIDs() [#getdrawableids]

\> **getDrawableIDs**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5151

Gets all the drawables' IDs.

#### Returns [#returns-9]

`string`\[]

IDs.

#### Overrides [#overrides-13]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableIDs`](/pixi-vn-live2d/core/classes/InternalModel#getdrawableids)

***

### getDrawableIndex() [#getdrawableindex]

\> **getDrawableIndex**(`id`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5152

Finds the index of a drawable by its ID.

#### Parameters [#parameters-7]

##### id [#id]

`string`

#### Returns [#returns-10]

`number`

The index.

#### Overrides [#overrides-14]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableIndex`](/pixi-vn-live2d/core/classes/InternalModel#getdrawableindex)

***

### getDrawableVertices() [#getdrawablevertices]

\> **getDrawableVertices**(`drawIndex`): `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5153

Gets a drawable's vertices.

#### Parameters [#parameters-8]

##### drawIndex [#drawindex]

`string` | `number`

#### Returns [#returns-11]

`Float32Array`

#### Throws [#throws]

Error when the drawable cannot be found.

#### Overrides [#overrides-15]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getDrawableVertices`](/pixi-vn-live2d/core/classes/InternalModel#getdrawablevertices)

***

### getHitAreaDefs() [#gethitareadefs]

\> `protected` **getHitAreaDefs**(): [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5150

Gets all the hit area definitions.

#### Returns [#returns-12]

[`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Normalized definitions.

#### Overrides [#overrides-16]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getHitAreaDefs`](/pixi-vn-live2d/core/classes/InternalModel#gethitareadefs)

***

### getLayout() [#getlayout]

\> `protected` **getLayout**(): [`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5147

Gets the layout definition.

#### Returns [#returns-13]

[`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Normalized definition.

#### Overrides [#overrides-17]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getLayout`](/pixi-vn-live2d/core/classes/InternalModel#getlayout)

***

### getSize() [#getsize]

\> `protected` **getSize**(): \[`number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5143

Gets the model's original canvas size.

#### Returns [#returns-14]

\[`number`, `number`]

`[width, height]`

#### Overrides [#overrides-18]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`getSize`](/pixi-vn-live2d/core/classes/InternalModel#getsize)

***

### hitTest() [#hittest]

\> **hitTest**(`x`, `y`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5154

Hit-test on the model.

#### Parameters [#parameters-9]

##### x [#x]

`number`

Position in model canvas.

##### y [#y]

`number`

Position in model canvas.

#### Returns [#returns-15]

`string`\[]

The names of the *hit* hit areas. Can be empty if none is hit.

#### Overrides [#overrides-19]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`hitTest`](/pixi-vn-live2d/core/classes/InternalModel#hittest)

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5142

Should be called in the constructor of derived class.

#### Returns [#returns-16]

`void`

#### Overrides [#overrides-20]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`init`](/pixi-vn-live2d/core/classes/InternalModel#init)

***

### isHit() [#ishit]

\> **isHit**(`hitAreaName`, `x`, `y`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3230

Hit-test for a single hit area.

#### Parameters [#parameters-10]

##### hitAreaName [#hitareaname]

`string`

The hit area's name.

##### x [#x-1]

`number`

Position in model canvas.

##### y [#y-1]

`number`

Position in model canvas.

#### Returns [#returns-17]

`boolean`

True if hit.

#### Inherited from [#inherited-from-15]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`isHit`](/pixi-vn-live2d/core/classes/InternalModel#ishit)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-11]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-18]

`number`

#### Inherited from [#inherited-from-16]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`listenerCount`](/pixi-vn-live2d/core/classes/InternalModel#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-3]

`T`

#### Returns [#returns-19]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-17]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`listeners`](/pixi-vn-live2d/core/classes/InternalModel#listeners)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-13]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-20]

`this`

#### Inherited from [#inherited-from-18]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`off`](/pixi-vn-live2d/core/classes/InternalModel#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-14]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-19]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`on`](/pixi-vn-live2d/core/classes/InternalModel#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-15]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-20]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`once`](/pixi-vn-live2d/core/classes/InternalModel#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-16]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-21]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`removeAllListeners`](/pixi-vn-live2d/core/classes/InternalModel#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-17]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-22]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`removeListener`](/pixi-vn-live2d/core/classes/InternalModel#removelistener)

***

### setupHitAreas() [#setuphitareas]

\> `protected` **setupHitAreas**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3215

Sets up the hit areas by their definitions in settings.

#### Returns [#returns-25]

`void`

#### Inherited from [#inherited-from-23]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`setupHitAreas`](/pixi-vn-live2d/core/classes/InternalModel#setuphitareas)

***

### setupLayout() [#setuplayout]

\> `protected` **setupLayout**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3211

Sets up the model's size and local transform by the model's layout.

#### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-24]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`setupLayout`](/pixi-vn-live2d/core/classes/InternalModel#setuplayout)

***

### update() [#update]

\> **update**(`dt`, `now`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5155

Updates the model's parameters.

#### Parameters [#parameters-18]

##### dt [#dt]

`number`

Elapsed time in milliseconds from last frame.

##### now [#now]

`number`

#### Returns [#returns-27]

`void`

#### Overrides [#overrides-21]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`update`](/pixi-vn-live2d/core/classes/InternalModel#update)

***

### updateFocus() [#updatefocus]

\> **updateFocus**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5156

#### Returns [#returns-28]

`void`

***

### updateMotions() [#updatemotions]

\> `protected` **updateMotions**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3270

Updates all active motions for the model and emits lifecycle events.

This method coordinates the update cycle for both primary and parallel motion managers,
ensuring all animations are synchronized with the current timestamp. It emits events
before and after the update process, allowing external listeners to hook into the motion
lifecycle. The return value indicates whether any motion was actively updated during this cycle.

#### Parameters [#parameters-19]

##### model [#model]

`object`

The model instance to apply motion updates to.

##### now [#now-1]

`number`

The current timestamp (in milliseconds) used to calculate motion progress.

#### Returns [#returns-29]

`boolean`

Returns `true` if any motion (primary or parallel) was updated; `false` otherwise.

#### Emits [#emits-2]

beforeMotionUpdate - Triggered before any motion updates are processed.

#### Emits [#emits-3]

afterMotionUpdate - Triggered after all motion updates are completed.

#### Inherited from [#inherited-from-25]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateMotions`](/pixi-vn-live2d/core/classes/InternalModel#updatemotions)

***

### updateNaturalMovements() [#updatenaturalmovements]

\> **updateNaturalMovements**(`_dt`, `now`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5157

#### Parameters [#parameters-20]

##### \_dt [#_dt]

`number`

##### now [#now-2]

`number`

#### Returns [#returns-30]

`void`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`transform`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3242

Updates the model's transform.

#### Parameters [#parameters-21]

##### transform [#transform]

`Matrix`

The world transform.

#### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-26]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateTransform`](/pixi-vn-live2d/core/classes/InternalModel#updatetransform)

***

### updateWebGLContext() [#updatewebglcontext]

\> **updateWebGLContext**(`gl`, `glContextID`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5148

Updates WebGL context bound to this model.

#### Parameters [#parameters-22]

##### gl [#gl-1]

`WebGLRenderingContext`

WebGL context.

##### glContextID [#glcontextid]

`number`

Unique ID for given WebGL context.

#### Returns [#returns-32]

`void`

#### Overrides [#overrides-22]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel).[`updateWebGLContext`](/pixi-vn-live2d/core/classes/InternalModel#updatewebglcontext)


# Class: CubismLegacyModelSettings (/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4985

Parses, and provides access to the settings JSON.

## Extends [#extends]

* [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismLegacyModelSettings**(`json`): `CubismLegacyModelSettings`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5002

#### Parameters [#parameters]

##### json [#json]

[`ModelJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ModelJSON) & `object`

#### Returns [#returns]

`CubismLegacyModelSettings`

#### Overrides [#overrides]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`constructor`](/pixi-vn-live2d/core/classes/ModelSettings#constructor)

## Properties [#properties]

### expressions? [#expressions]

\> `optional` **expressions?**: [`Expression`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4995

***

### hitAreas? [#hitareas]

\> `optional` **hitAreas?**: [`HitArea`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/HitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4992

***

### initOpacities? [#initopacities]

\> `optional` **initOpacities?**: [`InitOpacity`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitOpacity)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4994

***

### initParams? [#initparams]

\> `optional` **initParams?**: [`InitParam`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitParam)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4993

***

### json [#json-1]

\> **json**: [`ModelJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ModelJSON)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4986

#### Overrides [#overrides-1]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`json`](/pixi-vn-live2d/core/classes/ModelSettings#json)

***

### layout? [#layout]

\> `optional` **layout?**: [`Layout`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Layout)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4991

***

### moc [#moc]

\> **moc**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4987

Relative path of he moc file, typically ends with `.moc` in Cubism 2 and `.moc3` in Cubism 4.

#### Overrides [#overrides-2]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`moc`](/pixi-vn-live2d/core/classes/ModelSettings#moc)

***

### motions [#motions]

\> **motions**: `Record`\<`string`, [`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4996

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:519

The model's name, typically used for displaying or logging. By default it's inferred from
the URL by taking the folder name (the second to last component). In Cubism 2 it'll be overwritten
by the `name` field of settings JSON.

#### Inherited from [#inherited-from]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`name`](/pixi-vn-live2d/core/classes/ModelSettings#name)

***

### physics? [#physics]

\> `optional` **physics?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4990

Relative path of the physics file.

#### Overrides [#overrides-3]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`physics`](/pixi-vn-live2d/core/classes/ModelSettings#physics)

***

### pose? [#pose]

\> `optional` **pose?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4989

Relative path of the pose file.

#### Overrides [#overrides-4]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`pose`](/pixi-vn-live2d/core/classes/ModelSettings#pose)

***

### textures [#textures]

\> **textures**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4988

Relative paths of the texture images.

#### Overrides [#overrides-5]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`textures`](/pixi-vn-live2d/core/classes/ModelSettings#textures)

***

### url [#url]

\> **url**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:524

URL of the model settings file, used to resolve paths of the resource files defined in settings.
This typically ends with `.model.json` in Cubism 2 and `.model3.json` in Cubism 4.

#### Inherited from [#inherited-from-1]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`url`](/pixi-vn-live2d/core/classes/ModelSettings#url)

## Methods [#methods]

### copy() [#copy]

\> `protected` **copy**(`json`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5008

Validates and copies *optional* properties from raw JSON.

#### Parameters [#parameters-1]

##### json [#json-2]

[`ModelJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ModelJSON)

#### Returns [#returns-1]

`void`

***

### getDefinedFiles() [#getdefinedfiles]

\> **getDefinedFiles**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:594

Retrieves all resource files defined in the settings.

#### Returns [#returns-2]

`string`\[]

A flat array of the paths of all resource files.

```js
modelSettings.getDefinedFiles();
// returns: ["foo.moc", "foo.png", ...]
```

#### Inherited from [#inherited-from-2]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`getDefinedFiles`](/pixi-vn-live2d/core/classes/ModelSettings#getdefinedfiles)

***

### getFileStem() [#getfilestem]

\> `protected` **getFileStem**(`path?`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:560

Returns the file name without extension from a path.

#### Parameters [#parameters-2]

##### path? [#path]

`string`

#### Returns [#returns-3]

`string` | `undefined`

#### Inherited from [#inherited-from-3]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`getFileStem`](/pixi-vn-live2d/core/classes/ModelSettings#getfilestem)

***

### normalizeName() [#normalizename]

\> `protected` **normalizeName**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:551

Ensures the model name is meaningful; falls back to the folder name when missing or placeholder.

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-4]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`normalizeName`](/pixi-vn-live2d/core/classes/ModelSettings#normalizename)

***

### replaceFiles() [#replacefiles]

\> **replaceFiles**(`replace`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5009

Replaces the resource files by running each file through the `replacer`.

#### Parameters [#parameters-3]

##### replace [#replace]

(`file`, `path`) => `string`

#### Returns [#returns-5]

`void`

#### Overrides [#overrides-6]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`replaceFiles`](/pixi-vn-live2d/core/classes/ModelSettings#replacefiles)

***

### resolveURL() [#resolveurl]

\> **resolveURL**(`path`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:567

Resolves a relative path using the [url](/pixi-vn-live2d/core/classes/ModelSettings#url). This is used to resolve the resource files
defined in the settings.

#### Parameters [#parameters-4]

##### path [#path-1]

`string`

Relative path.

#### Returns [#returns-6]

`string`

Resolved path.

#### Inherited from [#inherited-from-5]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`resolveURL`](/pixi-vn-live2d/core/classes/ModelSettings#resolveurl)

***

### setModelName() [#setmodelname]

\> `protected` **setModelName**(...`candidates`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:556

Picks the first non-empty, non-placeholder name from candidates and applies it.
Falls back to [normalizeName](/pixi-vn-live2d/core/classes/ModelSettings#normalizename) when no candidate is usable.

#### Parameters [#parameters-5]

##### candidates [#candidates]

...(`string` | `undefined`)\[]

#### Returns [#returns-7]

`void`

#### Inherited from [#inherited-from-6]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`setModelName`](/pixi-vn-live2d/core/classes/ModelSettings#setmodelname)

***

### validateFiles() [#validatefiles]

\> **validateFiles**(`files`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:603

Validates that the files defined in the settings exist in given files. Each file will be
resolved by [resolveURL](/pixi-vn-live2d/core/functions/resolveURL) before comparison.

#### Parameters [#parameters-6]

##### files [#files]

`string`\[]

A flat array of file paths.

#### Returns [#returns-8]

`string`\[]

All the files which are defined in the settings and also exist in given files,
*including the optional files*.

#### Throws [#throws]

Error if any *essential* file is defined in settings but not included in given files.

#### Inherited from [#inherited-from-7]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`validateFiles`](/pixi-vn-live2d/core/classes/ModelSettings#validatefiles)

***

### isValidJSON() [#isvalidjson]

\> `static` **isValidJSON**(`json`): `json is ModelJSON`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5001

Checks if a JSON object is valid model settings.

#### Parameters [#parameters-7]

##### json [#json-3]

`unknown`

#### Returns [#returns-9]

`json is ModelJSON`


# Class: CubismLegacyMotionManager (/pixi-vn-live2d/core/classes/CubismLegacyMotionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5030

Handles the motion playback for Live2D models.
Responsible for loading, playing, and managing motion states and audio.

## Emits [#emits]

[MotionManagerEvents](/pixi-vn-live2d/core/interfaces/MotionManagerEvents)

## Extends [#extends]

* [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)\<`Live2DMotion`, [`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismLegacyMotionManager**(`parent`): `CubismLegacyMotionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5040

#### Parameters [#parameters]

##### parent [#parent]

[`CubismLegacyInternalModel`](/pixi-vn-live2d/core/classes/CubismLegacyInternalModel)

#### Returns [#returns]

`CubismLegacyMotionManager`

#### Overrides [#overrides]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`constructor`](/pixi-vn-live2d/core/classes/MotionManager#constructor)

## Properties [#properties]

### currentAnalyzer? [#currentanalyzer]

\> `optional` **currentAnalyzer?**: `AnalyserNode`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3434

Analyzer element for the current sound being played.

#### Inherited from [#inherited-from]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentAnalyzer`](/pixi-vn-live2d/core/classes/MotionManager#currentanalyzer)

***

### currentAudio? [#currentaudio]

\> `optional` **currentAudio?**: `Sound`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3429

Audio element of the current motion if a sound file is defined with it.

#### Inherited from [#inherited-from-1]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentAudio`](/pixi-vn-live2d/core/classes/MotionManager#currentaudio)

***

### currentContext? [#currentcontext]

\> `optional` **currentContext?**: `AudioContext`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3439

Context element for the current sound being played.

#### Inherited from [#inherited-from-2]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentContext`](/pixi-vn-live2d/core/classes/MotionManager#currentcontext)

***

### definitions [#definitions]

\> `abstract` `readonly` **definitions**: `Partial`\<`Record`\<`string`, [`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5031

Motion definitions copied from ModelSettings.

#### Overrides [#overrides-1]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`definitions`](/pixi-vn-live2d/core/classes/MotionManager#definitions)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3449

Flags whether the instance has been destroyed.

#### Inherited from [#inherited-from-3]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`destroyed`](/pixi-vn-live2d/core/classes/MotionManager#destroyed)

***

### expressionManager? [#expressionmanager]

\> `abstract` `optional` **expressionManager?**: [`CubismLegacyExpressionManager`](/pixi-vn-live2d/core/classes/CubismLegacyExpressionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5039

Expression manager for handling model expressions.
Can be undefined if the settings define no expression.

#### Overrides [#overrides-2]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`expressionManager`](/pixi-vn-live2d/core/classes/MotionManager#expressionmanager)

***

### groups [#groups]

\> `abstract` `readonly` **groups**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5032

Motion groups with specific internal usages. Includes at least the 'idle' field.

#### idle [#idle]

\> `readonly` **idle**: `"idle"`

#### Overrides [#overrides-3]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`groups`](/pixi-vn-live2d/core/classes/MotionManager#groups)

***

### lipSyncIds [#lipsyncids]

\> `readonly` **lipSyncIds**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5037

***

### motionDataType [#motiondatatype]

\> `abstract` `readonly` **motionDataType**: `"arraybuffer"` = `"arraybuffer"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5035

Indicates the content type of the motion files, varies in different Cubism versions.
Used as `xhr.responseType`.

#### Overrides [#overrides-4]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionDataType`](/pixi-vn-live2d/core/classes/MotionManager#motiondatatype)

***

### motionGroups [#motiongroups]

\> **motionGroups**: `Partial`\<`Record`\<`string`, (`Motion` | `undefined` | `null`)\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3419

The Motions. The structure is the same as [definitions](#definitions), initially each group contains
an empty array, which means all motions will be `undefined`. When a Motion has been loaded,
it'll fill the place in which it should be; when it fails to load, the place will be filled
with `null`.

#### Inherited from [#inherited-from-4]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionGroups`](/pixi-vn-live2d/core/classes/MotionManager#motiongroups)

***

### parent [#parent-1]

\> **parent**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3454

Reference to the parent InternalModel.

#### Inherited from [#inherited-from-5]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`parent`](/pixi-vn-live2d/core/classes/MotionManager#parent)

***

### playing [#playing]

\> **playing**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3444

Flags whether there is a motion currently playing.

#### Inherited from [#inherited-from-6]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`playing`](/pixi-vn-live2d/core/classes/MotionManager#playing)

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `MotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5036

***

### settings [#settings]

\> `readonly` **settings**: [`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5038

The ModelSettings reference.

#### Overrides [#overrides-5]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`settings`](/pixi-vn-live2d/core/classes/MotionManager#settings)

***

### state [#state]

\> **state**: [`MotionState`](/pixi-vn-live2d/core/classes/MotionState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3424

Maintains the state of this MotionManager.

#### Inherited from [#inherited-from-7]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`state`](/pixi-vn-live2d/core/classes/MotionManager#state)

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3378

Tag for logging.

#### Inherited from [#inherited-from-8]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`tag`](/pixi-vn-live2d/core/classes/MotionManager#tag)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-9]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`prefixed`](/pixi-vn-live2d/core/classes/MotionManager#prefixed)

## Methods [#methods]

### \_startMotion() [#_startmotion]

\> `abstract` `protected` **\_startMotion**(`motion`, `onFinish?`, `ignoreParamIds?`, `_loop?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5047

Starts the Motion.

#### Parameters [#parameters-1]

##### motion [#motion]

`Live2DMotion`

The Motion to start.

##### onFinish? [#onfinish]

(`motion`) => `void`

Optional callback when finished.

##### ignoreParamIds? [#ignoreparamids]

`string`\[]

The ids to be ignored.

##### \_loop? [#_loop]

`boolean`

#### Returns [#returns-1]

`number`

An ID or token for the motion.

#### Overrides [#overrides-6]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`_startMotion`](/pixi-vn-live2d/core/classes/MotionManager#_startmotion)

***

### \_stopAllMotions() [#_stopallmotions]

\> `abstract` `protected` **\_stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5048

Stops all playing motions.

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-7]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`_stopAllMotions`](/pixi-vn-live2d/core/classes/MotionManager#_stopallmotions)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-10]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`addListener`](/pixi-vn-live2d/core/classes/MotionManager#addlistener)

***

### createMotion() [#createmotion]

\> `abstract` **createMotion**(`data`, `group`, `definition`): `Live2DMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5043

Creates a Motion from the data.

#### Parameters [#parameters-3]

##### data [#data]

`ArrayBuffer`

Content of the motion file. The format must be consistent with [MotionManager#motionDataType](/pixi-vn-live2d/core/classes/MotionManager#motiondatatype).

##### group [#group]

`string`

The motion group.

##### definition [#definition]

[`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)

The motion definition.

#### Returns [#returns-4]

`Live2DMotion`

The created Motion.

#### Overrides [#overrides-8]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`createMotion`](/pixi-vn-live2d/core/classes/MotionManager#createmotion)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5050

Destroys the instance and releases all resources.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[MotionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#destroy)

#### Overrides [#overrides-9]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`destroy`](/pixi-vn-live2d/core/classes/MotionManager#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-11]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`emit`](/pixi-vn-live2d/core/classes/MotionManager#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-12]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`eventNames`](/pixi-vn-live2d/core/classes/MotionManager#eventnames)

***

### getMotionAndApplyExpression() [#getmotionandapplyexpression]

\> `protected` **getMotionAndApplyExpression**(`group`, `index`, `expression?`): `Promise`\<`unknown`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3637

Loads a motion and applies the given expression with FORCE priority.

#### Parameters [#parameters-5]

##### group [#group-1]

`string`

The motion group.

##### index [#index]

`number`

The motion index.

##### expression? [#expression]

`string` | `number`

Expression to apply (optional).

#### Returns [#returns-8]

`Promise`\<`unknown`>

The loaded motion, or null if not started.

#### Inherited from [#inherited-from-13]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionAndApplyExpression`](/pixi-vn-live2d/core/classes/MotionManager#getmotionandapplyexpression)

***

### getMotionFile() [#getmotionfile]

\> `abstract` **getMotionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5044

Retrieves the motion's file path by its definition.

#### Parameters [#parameters-6]

##### definition [#definition-1]

[`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)

Motion definition.

#### Returns [#returns-9]

`string`

The file path extracted from the given definition. Not resolved.

#### Overrides [#overrides-10]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionFile`](/pixi-vn-live2d/core/classes/MotionManager#getmotionfile)

***

### getMotionName() [#getmotionname]

\> `abstract` `protected` **getMotionName**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5045

Retrieves the motion's name by its definition.

#### Parameters [#parameters-7]

##### definition [#definition-2]

[`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)

Motion definition.

#### Returns [#returns-10]

`string`

The motion's name.

#### Overrides [#overrides-11]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionName`](/pixi-vn-live2d/core/classes/MotionManager#getmotionname)

***

### getSoundFile() [#getsoundfile]

\> `abstract` `protected` **getSoundFile**(`definition`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5046

Retrieves the motion's sound file by its definition.

#### Parameters [#parameters-8]

##### definition [#definition-3]

[`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)

Motion definition.

#### Returns [#returns-11]

`string` | `undefined`

The motion's sound file, or undefined.

#### Overrides [#overrides-12]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getSoundFile`](/pixi-vn-live2d/core/classes/MotionManager#getsoundfile)

***

### init() [#init]

\> `protected` **init**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5041

Should be called in the constructor of derived class to initialize options and setup motions.

#### Parameters [#parameters-9]

##### options? [#options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Initialization options for the manager.

#### Returns [#returns-12]

`void`

#### Overrides [#overrides-13]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`init`](/pixi-vn-live2d/core/classes/MotionManager#init)

***

### initializeAudio() [#initializeaudio]

\> `protected` **initializeAudio**(`audio`, `volume`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3490

Initializes audio playback and sets up audio analysis for lipsync.

#### Parameters [#parameters-10]

##### audio [#audio]

`Sound`

The Sound to initialize.

##### volume [#volume]

`number`

The playback volume (0-1).

#### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-14]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`initializeAudio`](/pixi-vn-live2d/core/classes/MotionManager#initializeaudio)

***

### isFinished() [#isfinished]

\> `abstract` **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5042

Checks if the motion playback has finished.

#### Returns [#returns-14]

`boolean`

#### Overrides [#overrides-14]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`isFinished`](/pixi-vn-live2d/core/classes/MotionManager#isfinished)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-11]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-15]

`number`

#### Inherited from [#inherited-from-15]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`listenerCount`](/pixi-vn-live2d/core/classes/MotionManager#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-3]

`T`

#### Returns [#returns-16]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-16]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`listeners`](/pixi-vn-live2d/core/classes/MotionManager#listeners)

***

### loadMotion() [#loadmotion]

\> **loadMotion**(`group`, `index`): `Promise`\<`Live2DMotion` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3479

Loads a Motion in a motion group. Errors in this method will not be thrown,
but be emitted with a "motionLoadError" event.

#### Parameters [#parameters-13]

##### group [#group-2]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

#### Returns [#returns-17]

`Promise`\<`Live2DMotion` | `undefined`>

Promise that resolves with the Motion, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[MotionManagerEvents.motionLoaded](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaded)

#### Emits [#emits-3]

[MotionManagerEvents.motionLoadError](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaderror)

#### Inherited from [#inherited-from-17]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`loadMotion`](/pixi-vn-live2d/core/classes/MotionManager#loadmotion)

***

### motionLastFrame() [#motionlastframe]

\> `abstract` **motionLastFrame**(`group`, `index`, `expression?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5051

Play the last frame of the given motion, optionally applying an expression.

#### Parameters [#parameters-14]

##### group [#group-3]

`string`

Motion group.

##### index [#index-2]

`number`

Motion index.

##### expression? [#expression-1]

Expression to apply (optional).

###### expression? [#expression-2]

`string` | `number`

#### Returns [#returns-18]

`Promise`\<`boolean`>

Promise resolving to true if successful.

#### Overrides [#overrides-15]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionLastFrame`](/pixi-vn-live2d/core/classes/MotionManager#motionlastframe)

***

### mouthSync() [#mouthsync]

\> **mouthSync**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3560

Move the mouth for lipsync.

#### Returns [#returns-19]

`number`

The current lipsync value.

#### Inherited from [#inherited-from-18]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`mouthSync`](/pixi-vn-live2d/core/classes/MotionManager#mouthsync)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-15]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-20]

`this`

#### Inherited from [#inherited-from-19]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`off`](/pixi-vn-live2d/core/classes/MotionManager#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-16]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-20]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`on`](/pixi-vn-live2d/core/classes/MotionManager#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-17]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-21]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`once`](/pixi-vn-live2d/core/classes/MotionManager#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-18]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-22]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`removeAllListeners`](/pixi-vn-live2d/core/classes/MotionManager#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-19]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-23]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`removeListener`](/pixi-vn-live2d/core/classes/MotionManager#removelistener)

***

### setupMotions() [#setupmotions]

\> `protected` **setupMotions**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3469

Sets up motions from the definitions, and preloads them according to the preload strategy.

#### Parameters [#parameters-20]

##### options? [#options-1]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Options controlling which motions to preload.

#### Returns [#returns-25]

`void`

#### Inherited from [#inherited-from-24]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`setupMotions`](/pixi-vn-live2d/core/classes/MotionManager#setupmotions)

***

### speak() [#speak]

\> **speak**(`sound`, `volume?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3502

Only play sound with lip sync.

#### Parameters [#parameters-21]

##### sound [#sound]

`string`

The audio url or base64 content.

##### volume? [#volume-1]

Volume of the sound (0-1).

###### expression? [#expression-3]

`string` | `number`

###### onError? [#onerror]

(`e`) => `void`

###### onFinish? [#onfinish-1]

() => `void`

###### resetExpression? [#resetexpression]

`boolean`

###### volume? [#volume-2]

`number`

#### Returns [#returns-26]

`Promise`\<`boolean`>

Promise that resolves with true if the sound is playing, false otherwise.

#### Inherited from [#inherited-from-25]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`speak`](/pixi-vn-live2d/core/classes/MotionManager#speak)

***

### startMotion() [#startmotion]

\> **startMotion**(`group`, `index`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3525

Starts a motion with the given priority.

#### Parameters [#parameters-22]

##### group [#group-4]

`string`

The motion group.

##### index [#index-3]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: NORMAL (2).

##### sound? [#sound-1]

[`MotionStartOptions`](/pixi-vn-live2d/core/interfaces/MotionStartOptions)

The audio url or base64 content.

#### Returns [#returns-27]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

#### Inherited from [#inherited-from-26]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`startMotion`](/pixi-vn-live2d/core/classes/MotionManager#startmotion)

***

### startRandomMotion() [#startrandommotion]

\> **startRandomMotion**(`group`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3540

Starts a random Motion as given priority.

#### Parameters [#parameters-23]

##### group [#group-5]

`string`

The motion group.

##### priority? [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: IDLE (1).

##### sound? [#sound-2]

[`MotionStartRandomOptions`](/pixi-vn-live2d/core/type-aliases/MotionStartRandomOptions)

The audio url or base64 content.

#### Returns [#returns-28]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

#### Inherited from [#inherited-from-27]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`startRandomMotion`](/pixi-vn-live2d/core/classes/MotionManager#startrandommotion)

***

### stopAllMotions() [#stopallmotions]

\> **stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3548

Stops all playing motions as well as the sound.

#### Returns [#returns-29]

`void`

#### Inherited from [#inherited-from-28]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`stopAllMotions`](/pixi-vn-live2d/core/classes/MotionManager#stopallmotions)

***

### stopSpeaking() [#stopspeaking]

\> **stopSpeaking**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3544

Stops current audio playback and lipsync.

#### Returns [#returns-30]

`void`

#### Inherited from [#inherited-from-29]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`stopSpeaking`](/pixi-vn-live2d/core/classes/MotionManager#stopspeaking)

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3555

Updates parameters of the core model.

#### Parameters [#parameters-24]

##### model [#model]

`object`

The core model.

##### now [#now]

`number`

Current time in milliseconds.

#### Returns [#returns-31]

`boolean`

True if the parameters have been actually updated.

#### Inherited from [#inherited-from-30]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`update`](/pixi-vn-live2d/core/classes/MotionManager#update)

***

### updateParameters() [#updateparameters]

\> `abstract` `protected` **updateParameters**(`model`, `_now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5049

Updates parameters of the core model.

#### Parameters [#parameters-25]

##### model [#model-1]

`Live2DModelWebGL`

The core model.

##### \_now [#_now]

`number`

#### Returns [#returns-32]

`boolean`

True if the parameters have been actually updated.

#### Overrides [#overrides-16]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`updateParameters`](/pixi-vn-live2d/core/classes/MotionManager#updateparameters)


# Class: CubismLegacyParallelMotionManager (/pixi-vn-live2d/core/classes/CubismLegacyParallelMotionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5055

## Extends [#extends]

* `ParallelMotionManager`\<`Live2DMotion`, [`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismLegacyParallelMotionManager**(`parent`): `CubismLegacyParallelMotionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5057

#### Parameters [#parameters]

##### parent [#parent]

[`CubismLegacyInternalModel`](/pixi-vn-live2d/core/classes/CubismLegacyInternalModel)

#### Returns [#returns]

`CubismLegacyParallelMotionManager`

#### Overrides [#overrides]

`ParallelMotionManager<Live2DMotion, Cubism2Spec.Motion>.constructor`

## Properties [#properties]

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:776

Flags the instances has been destroyed.

#### Inherited from [#inherited-from]

[`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager).[`destroyed`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager#destroyed)

***

### manager [#manager]

\> **manager**: [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:760

#### Inherited from [#inherited-from-1]

[`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager).[`manager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager#manager)

***

### parent [#parent-1]

\> `readonly` **parent**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:777

#### Inherited from [#inherited-from-2]

[`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager).[`parent`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager#parent)

***

### playing [#playing]

\> **playing**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:772

Flags there's a motion playing.

#### Inherited from [#inherited-from-3]

[`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager).[`playing`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager#playing)

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `MotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5056

***

### settings [#settings]

\> `readonly` **settings**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:764

The ModelSettings reference.

#### Inherited from [#inherited-from-4]

`ParallelMotionManager.settings`

***

### state [#state]

\> **state**: [`MotionState`](/pixi-vn-live2d/core/classes/MotionState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:768

Maintains the state of this MotionManager.

#### Inherited from [#inherited-from-5]

`ParallelMotionManager.state`

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:759

Tag for logging.

#### Inherited from [#inherited-from-6]

[`CubismParallelMotionManager`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager).[`tag`](/pixi-vn-live2d/core/classes/CubismParallelMotionManager#tag)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-7]

`ParallelMotionManager.prefixed`

## Methods [#methods]

### \_startMotion() [#_startmotion]

\> `protected` **\_startMotion**(`motion`, `onFinish?`, `ignoreParamIds?`, `_loop?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5060

Starts the Motion.

#### Parameters [#parameters-1]

##### motion [#motion]

`Live2DMotion`

##### onFinish? [#onfinish]

(`motion`) => `void`

##### ignoreParamIds? [#ignoreparamids]

`string`\[]

##### \_loop? [#_loop]

`boolean`

#### Returns [#returns-1]

`number`

#### Overrides [#overrides-1]

`ParallelMotionManager._startMotion`

***

### \_stopAllMotions() [#_stopallmotions]

\> `protected` **\_stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5061

Stops all playing motions.

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-2]

`ParallelMotionManager._stopAllMotions`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-8]

`ParallelMotionManager.addListener`

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5063

Destroys the instance.

#### Returns [#returns-4]

`void`

#### Emits [#emits]

[MotionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#destroy)

#### Overrides [#overrides-3]

`ParallelMotionManager.destroy`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-3]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-9]

`ParallelMotionManager.emit`

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-6]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-10]

`ParallelMotionManager.eventNames`

***

### getMotionName() [#getmotionname]

\> `protected` **getMotionName**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5059

Retrieves the motion's name by its definition.

#### Parameters [#parameters-4]

##### definition [#definition]

[`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)

#### Returns [#returns-7]

`string`

The motion's name.

#### Overrides [#overrides-4]

`ParallelMotionManager.getMotionName`

***

### isFinished() [#isfinished]

\> **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5058

Checks if the motion playback has finished.

#### Returns [#returns-8]

`boolean`

#### Overrides [#overrides-5]

`ParallelMotionManager.isFinished`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-5]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-9]

`number`

#### Inherited from [#inherited-from-11]

`ParallelMotionManager.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-6]

##### event [#event-3]

`T`

#### Returns [#returns-10]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-12]

`ParallelMotionManager.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-7]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-11]

`this`

#### Inherited from [#inherited-from-13]

`ParallelMotionManager.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-8]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-12]

`this`

#### Inherited from [#inherited-from-14]

`ParallelMotionManager.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-9]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-13]

`this`

#### Inherited from [#inherited-from-15]

`ParallelMotionManager.once`

***

### playMotionLastFrame() [#playmotionlastframe]

\> **playMotionLastFrame**(`group`, `index`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5064

#### Parameters [#parameters-10]

##### group [#group]

`string`

##### index [#index]

`number`

#### Returns [#returns-14]

`Promise`\<`boolean`>

#### Overrides [#overrides-6]

`ParallelMotionManager.playMotionLastFrame`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-11]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-15]

`this`

#### Inherited from [#inherited-from-16]

`ParallelMotionManager.removeAllListeners`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-16]

`this`

#### Inherited from [#inherited-from-17]

`ParallelMotionManager.removeListener`

***

### startMotion() [#startmotion]

\> **startMotion**(`group`, `index`, `priority?`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:788

Starts a motion as given priority.

#### Parameters [#parameters-13]

##### group [#group-1]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. default: 2 (NORMAL)

##### options? [#options]

`string`\[] | [`ParallelMotionStartOptions`](/pixi-vn-live2d/core/interfaces/ParallelMotionStartOptions)

#### Returns [#returns-17]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-18]

`ParallelMotionManager.startMotion`

***

### startRandomMotion() [#startrandommotion]

\> **startRandomMotion**(`group`, `priority?`, `loop?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:796

Starts a random Motion as given priority.

#### Parameters [#parameters-14]

##### group [#group-2]

`string`

The motion group.

##### priority? [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. (default: 1 `IDLE`)

##### loop? [#loop]

[`ParallelMotionStartRandomOptions`](/pixi-vn-live2d/core/type-aliases/ParallelMotionStartRandomOptions)

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.

#### Returns [#returns-18]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-19]

`ParallelMotionManager.startRandomMotion`

***

### stopAllMotions() [#stopallmotions]

\> **stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:800

Stops all playing motions as well as the sound.

#### Returns [#returns-19]

`void`

#### Inherited from [#inherited-from-20]

`ParallelMotionManager.stopAllMotions`

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:807

Updates parameters of the core model.

#### Parameters [#parameters-15]

##### model [#model]

`object`

The core model.

##### now [#now]

`number`

Current time in milliseconds.

#### Returns [#returns-20]

`boolean`

True if the parameters have been actually updated.

#### Inherited from [#inherited-from-21]

`ParallelMotionManager.update`

***

### updateParameters() [#updateparameters]

\> `protected` **updateParameters**(`model`, `_now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5062

Updates parameters of the core model.

#### Parameters [#parameters-16]

##### model [#model-1]

`Live2DModelWebGL`

The core model.

##### \_now [#_now]

`number`

#### Returns [#returns-21]

`boolean`

True if the parameters have been actually updated.

#### Overrides [#overrides-7]

`ParallelMotionManager.updateParameters`


# Class: CubismModelSettings (/pixi-vn-live2d/core/classes/CubismModelSettings)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6022

Parses, and provides access to the settings JSON.

## Extends [#extends]

* [`CubismModelSettingJsonMixin`](/pixi-vn-live2d/core/type-aliases/CubismModelSettingJsonMixin).[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismModelSettings**(`json`): `CubismModelSettings`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6040

#### Parameters [#parameters]

##### json [#json]

`any`

#### Returns [#returns]

`CubismModelSettings`

#### Inherited from [#inherited-from]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`constructor`](/pixi-vn-live2d/core/classes/ModelSettings#constructor)

## Properties [#properties]

### expressions? [#expressions]

\> `optional` **expressions?**: `Expression`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6033

***

### getEyeBlinkParameterCount [#geteyeblinkparametercount]

\> **getEyeBlinkParameterCount**: () => `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6035

#### Returns [#returns-1]

`number`

#### Inherited from [#inherited-from-1]

`CubismModelSettingJsonMixin.getEyeBlinkParameterCount`

***

### getEyeBlinkParameterId [#geteyeblinkparameterid]

\> **getEyeBlinkParameterId**: (`index`) => `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6036

#### Parameters [#parameters-1]

##### index [#index]

`number`

#### Returns [#returns-2]

`CubismId`

#### Inherited from [#inherited-from-2]

`CubismModelSettingJsonMixin.getEyeBlinkParameterId`

***

### getLipSyncParameterCount [#getlipsyncparametercount]

\> **getLipSyncParameterCount**: () => `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6037

#### Returns [#returns-3]

`number`

#### Inherited from [#inherited-from-3]

`CubismModelSettingJsonMixin.getLipSyncParameterCount`

***

### getLipSyncParameterId [#getlipsyncparameterid]

\> **getLipSyncParameterId**: (`index`) => `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6038

#### Parameters [#parameters-2]

##### index [#index-1]

`number`

#### Returns [#returns-4]

`CubismId`

#### Inherited from [#inherited-from-4]

`CubismModelSettingJsonMixin.getLipSyncParameterId`

***

### hitAreas? [#hitareas]

\> `optional` **hitAreas?**: `object`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6029

#### Id [#id]

\> **Id**: `string`

#### Name [#name]

\> **Name**: `string`

***

### json [#json-1]

\> **json**: `ModelJSON`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6025

#### Inherited from [#inherited-from-5]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`json`](/pixi-vn-live2d/core/classes/ModelSettings#json)

***

### layout? [#layout]

\> `optional` **layout?**: `Record`\<`string`, `number`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6028

***

### moc [#moc]

\> **moc**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6026

Relative path of he moc file, typically ends with `.moc` in Cubism 2 and `.moc3` in Cubism 4.

#### Inherited from [#inherited-from-6]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`moc`](/pixi-vn-live2d/core/classes/ModelSettings#moc)

***

### motions? [#motions]

\> `optional` **motions?**: `Record`\<`string`, `Motion`\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6034

***

### name [#name-1]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:519

The model's name, typically used for displaying or logging. By default it's inferred from
the URL by taking the folder name (the second to last component). In Cubism 2 it'll be overwritten
by the `name` field of settings JSON.

#### Inherited from [#inherited-from-7]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`name`](/pixi-vn-live2d/core/classes/ModelSettings#name)

***

### physics? [#physics]

\> `optional` **physics?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:540

Relative path of the physics file.

#### Inherited from [#inherited-from-8]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`physics`](/pixi-vn-live2d/core/classes/ModelSettings#physics)

***

### pose? [#pose]

\> `optional` **pose?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:536

Relative path of the pose file.

#### Inherited from [#inherited-from-9]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`pose`](/pixi-vn-live2d/core/classes/ModelSettings#pose)

***

### textures [#textures]

\> **textures**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6027

Relative paths of the texture images.

#### Inherited from [#inherited-from-10]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`textures`](/pixi-vn-live2d/core/classes/ModelSettings#textures)

***

### url [#url]

\> **url**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:524

URL of the model settings file, used to resolve paths of the resource files defined in settings.
This typically ends with `.model.json` in Cubism 2 and `.model3.json` in Cubism 4.

#### Inherited from [#inherited-from-11]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`url`](/pixi-vn-live2d/core/classes/ModelSettings#url)

## Methods [#methods]

### getDefinedFiles() [#getdefinedfiles]

\> **getDefinedFiles**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:594

Retrieves all resource files defined in the settings.

#### Returns [#returns-5]

`string`\[]

A flat array of the paths of all resource files.

```js
modelSettings.getDefinedFiles();
// returns: ["foo.moc", "foo.png", ...]
```

#### Inherited from [#inherited-from-12]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`getDefinedFiles`](/pixi-vn-live2d/core/classes/ModelSettings#getdefinedfiles)

***

### getExpressionCount() [#getexpressioncount]

\> **getExpressionCount**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5794

表情設定ファイルの数を取得する

#### Returns [#returns-6]

`number`

表情設定ファイルの数

#### Inherited from [#inherited-from-13]

`CubismModelSettingJsonMixin.getExpressionCount`

***

### getExpressionFileName() [#getexpressionfilename]

\> **getExpressionFileName**(`index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5806

表情設定ファイルの名前を取得する

#### Parameters [#parameters-3]

##### index [#index-2]

`number`

配列のインデックス値

#### Returns [#returns-7]

`string`

表情設定ファイルの名前

#### Inherited from [#inherited-from-14]

`CubismModelSettingJsonMixin.getExpressionFileName`

***

### getExpressionName() [#getexpressionname]

\> **getExpressionName**(`index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5800

表情設定ファイルを識別する名前（別名）を取得する

#### Parameters [#parameters-4]

##### index [#index-3]

`number`

配列のインデックス値

#### Returns [#returns-8]

`string`

表情の名前

#### Inherited from [#inherited-from-15]

`CubismModelSettingJsonMixin.getExpressionName`

***

### getEyeBlinkParameters() [#geteyeblinkparameters]

\> **getEyeBlinkParameters**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6044

#### Returns [#returns-9]

`string`\[]

***

### getFileStem() [#getfilestem]

\> `protected` **getFileStem**(`path?`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:560

Returns the file name without extension from a path.

#### Parameters [#parameters-5]

##### path? [#path]

`string`

#### Returns [#returns-10]

`string` | `undefined`

#### Inherited from [#inherited-from-16]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`getFileStem`](/pixi-vn-live2d/core/classes/ModelSettings#getfilestem)

***

### getHitAreaId() [#gethitareaid]

\> **getHitAreaId**(`index`): `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5773

当たり判定に設定されたIDを取得する

#### Parameters [#parameters-6]

##### index [#index-4]

`number`

配列のindex

#### Returns [#returns-11]

`CubismId`

当たり判定に設定されたID

#### Inherited from [#inherited-from-17]

`CubismModelSettingJsonMixin.getHitAreaId`

***

### getHitAreaName() [#gethitareaname]

\> **getHitAreaName**(`index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5779

当たり判定に設定された名前を取得する

#### Parameters [#parameters-7]

##### index [#index-5]

`number`

配列のインデックス値

#### Returns [#returns-12]

`string`

当たり判定に設定された名前

#### Inherited from [#inherited-from-18]

`CubismModelSettingJsonMixin.getHitAreaName`

***

### getHitAreasCount() [#gethitareascount]

\> **getHitAreasCount**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5766

モデルに設定された当たり判定の数を取得する

#### Returns [#returns-13]

`number`

モデルに設定された当たり判定の数

#### Inherited from [#inherited-from-19]

`CubismModelSettingJsonMixin.getHitAreasCount`

***

### getJson() [#getjson]

\> **getJson**(): `CubismJson`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5740

CubismJsonオブジェクトを取得する

#### Returns [#returns-14]

`CubismJson`

CubismJson

#### Inherited from [#inherited-from-20]

`CubismModelSettingJsonMixin.getJson`

***

### getLayoutMap() [#getlayoutmap]

\> **getLayoutMap**(`outLayoutMap`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5863

レイアウト情報を取得する

#### Parameters [#parameters-8]

##### outLayoutMap [#outlayoutmap]

`csmMap`\<`string`, `number`>

csmMapクラスのインスタンス

#### Returns [#returns-15]

`boolean`

true レイアウト情報が存在する

#### Inherited from [#inherited-from-21]

`CubismModelSettingJsonMixin.getLayoutMap`

***

### getLipSyncParameters() [#getlipsyncparameters]

\> **getLipSyncParameters**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6045

#### Returns [#returns-16]

`string`\[]

***

### getModelFileName() [#getmodelfilename]

\> **getModelFileName**(): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5745

Mocファイルの名前を取得する

#### Returns [#returns-17]

`string`

Mocファイルの名前

#### Inherited from [#inherited-from-22]

`CubismModelSettingJsonMixin.getModelFileName`

***

### getMotionCount() [#getmotioncount]

\> **getMotionCount**(`groupName`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5823

モーショングループに含まれるモーションの数を取得する

#### Parameters [#parameters-9]

##### groupName [#groupname]

`string`

モーショングループの名前

#### Returns [#returns-18]

`number`

モーショングループの数

#### Inherited from [#inherited-from-23]

`CubismModelSettingJsonMixin.getMotionCount`

***

### getMotionFadeInTimeValue() [#getmotionfadeintimevalue]

\> **getMotionFadeInTimeValue**(`groupName`, `index`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5844

モーション開始時のフェードイン処理時間を取得する

#### Parameters [#parameters-10]

##### groupName [#groupname-1]

`string`

モーショングループの名前

##### index [#index-6]

`number`

配列のインデックス値

#### Returns [#returns-19]

`number`

フェードイン処理時間\[秒]

#### Inherited from [#inherited-from-24]

`CubismModelSettingJsonMixin.getMotionFadeInTimeValue`

***

### getMotionFadeOutTimeValue() [#getmotionfadeouttimevalue]

\> **getMotionFadeOutTimeValue**(`groupName`, `index`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5851

モーション終了時のフェードアウト処理時間を取得する

#### Parameters [#parameters-11]

##### groupName [#groupname-2]

`string`

モーショングループの名前

##### index [#index-7]

`number`

配列のインデックス値

#### Returns [#returns-20]

`number`

フェードアウト処理時間\[秒]

#### Inherited from [#inherited-from-25]

`CubismModelSettingJsonMixin.getMotionFadeOutTimeValue`

***

### getMotionFileName() [#getmotionfilename]

\> **getMotionFileName**(`groupName`, `index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5830

グループ名とインデックス値からモーションファイル名を取得する

#### Parameters [#parameters-12]

##### groupName [#groupname-3]

`string`

モーショングループの名前

##### index [#index-8]

`number`

配列のインデックス値

#### Returns [#returns-21]

`string`

モーションファイルの名前

#### Inherited from [#inherited-from-26]

`CubismModelSettingJsonMixin.getMotionFileName`

***

### getMotionGroupCount() [#getmotiongroupcount]

\> **getMotionGroupCount**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5811

モーショングループの数を取得する

#### Returns [#returns-22]

`number`

モーショングループの数

#### Inherited from [#inherited-from-27]

`CubismModelSettingJsonMixin.getMotionGroupCount`

***

### getMotionGroupName() [#getmotiongroupname]

\> **getMotionGroupName**(`index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5817

モーショングループの名前を取得する

#### Parameters [#parameters-13]

##### index [#index-9]

`number`

配列のインデックス値

#### Returns [#returns-23]

`string`

モーショングループの名前

#### Inherited from [#inherited-from-28]

`CubismModelSettingJsonMixin.getMotionGroupName`

***

### getMotionSoundFileName() [#getmotionsoundfilename]

\> **getMotionSoundFileName**(`groupName`, `index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5837

モーションに対応するサウンドファイルの名前を取得する

#### Parameters [#parameters-14]

##### groupName [#groupname-4]

`string`

モーショングループの名前

##### index [#index-10]

`number`

配列のインデックス値

#### Returns [#returns-24]

`string`

サウンドファイルの名前

#### Inherited from [#inherited-from-29]

`CubismModelSettingJsonMixin.getMotionSoundFileName`

***

### getPhysicsFileName() [#getphysicsfilename]

\> **getPhysicsFileName**(): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5784

物理演算設定ファイルの名前を取得する

#### Returns [#returns-25]

`string`

物理演算設定ファイルの名前

#### Inherited from [#inherited-from-30]

`CubismModelSettingJsonMixin.getPhysicsFileName`

***

### getPoseFileName() [#getposefilename]

\> **getPoseFileName**(): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5789

パーツ切り替え設定ファイルの名前を取得する

#### Returns [#returns-26]

`string`

パーツ切り替え設定ファイルの名前

#### Inherited from [#inherited-from-31]

`CubismModelSettingJsonMixin.getPoseFileName`

***

### getTextureCount() [#gettexturecount]

\> **getTextureCount**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5750

モデルが使用するテクスチャの数を取得する
テクスチャの数

#### Returns [#returns-27]

`number`

#### Inherited from [#inherited-from-32]

`CubismModelSettingJsonMixin.getTextureCount`

***

### getTextureDirectory() [#gettexturedirectory]

\> **getTextureDirectory**(): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5755

テクスチャが配置されたディレクトリの名前を取得する

#### Returns [#returns-28]

`string`

テクスチャが配置されたディレクトリの名前

#### Inherited from [#inherited-from-33]

`CubismModelSettingJsonMixin.getTextureDirectory`

***

### getTextureFileName() [#gettexturefilename]

\> **getTextureFileName**(`index`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5761

モデルが使用するテクスチャの名前を取得する

#### Parameters [#parameters-15]

##### index [#index-11]

`number`

配列のインデックス値

#### Returns [#returns-29]

`string`

テクスチャの名前

#### Inherited from [#inherited-from-34]

`CubismModelSettingJsonMixin.getTextureFileName`

***

### getUserDataFile() [#getuserdatafile]

\> **getUserDataFile**(): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5856

ユーザーデータのファイル名を取得する

#### Returns [#returns-30]

`string`

ユーザーデータのファイル名

#### Inherited from [#inherited-from-35]

`CubismModelSettingJsonMixin.getUserDataFile`

***

### normalizeName() [#normalizename]

\> `protected` **normalizeName**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:551

Ensures the model name is meaningful; falls back to the folder name when missing or placeholder.

#### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-36]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`normalizeName`](/pixi-vn-live2d/core/classes/ModelSettings#normalizename)

***

### release() [#release]

\> **release**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5734

デストラクタ相当の処理

#### Returns [#returns-32]

`void`

#### Inherited from [#inherited-from-37]

`CubismModelSettingJsonMixin.release`

***

### replaceFiles() [#replacefiles]

\> **replaceFiles**(`replace`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6043

Replaces the resource files by running each file through the `replacer`.

#### Parameters [#parameters-16]

##### replace [#replace]

(`file`, `path`) => `string`

#### Returns [#returns-33]

`void`

#### Inherited from [#inherited-from-38]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`replaceFiles`](/pixi-vn-live2d/core/classes/ModelSettings#replacefiles)

***

### resolveURL() [#resolveurl]

\> **resolveURL**(`path`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:567

Resolves a relative path using the [url](/pixi-vn-live2d/core/classes/ModelSettings#url). This is used to resolve the resource files
defined in the settings.

#### Parameters [#parameters-17]

##### path [#path-1]

`string`

Relative path.

#### Returns [#returns-34]

`string`

Resolved path.

#### Inherited from [#inherited-from-39]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`resolveURL`](/pixi-vn-live2d/core/classes/ModelSettings#resolveurl)

***

### setModelName() [#setmodelname]

\> `protected` **setModelName**(...`candidates`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:556

Picks the first non-empty, non-placeholder name from candidates and applies it.
Falls back to [normalizeName](/pixi-vn-live2d/core/classes/ModelSettings#normalizename) when no candidate is usable.

#### Parameters [#parameters-18]

##### candidates [#candidates]

...(`string` | `undefined`)\[]

#### Returns [#returns-35]

`void`

#### Inherited from [#inherited-from-40]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`setModelName`](/pixi-vn-live2d/core/classes/ModelSettings#setmodelname)

***

### validateFiles() [#validatefiles]

\> **validateFiles**(`files`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:603

Validates that the files defined in the settings exist in given files. Each file will be
resolved by [resolveURL](/pixi-vn-live2d/core/functions/resolveURL) before comparison.

#### Parameters [#parameters-19]

##### files [#files]

`string`\[]

A flat array of file paths.

#### Returns [#returns-36]

`string`\[]

All the files which are defined in the settings and also exist in given files,
*including the optional files*.

#### Throws [#throws]

Error if any *essential* file is defined in settings but not included in given files.

#### Inherited from [#inherited-from-41]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings).[`validateFiles`](/pixi-vn-live2d/core/classes/ModelSettings#validatefiles)

***

### isValidJSON() [#isvalidjson]

\> `static` **isValidJSON**(`json`): `json is ModelJSON`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6039

#### Parameters [#parameters-20]

##### json [#json-2]

`unknown`

#### Returns [#returns-37]

`json is ModelJSON`


# Class: CubismMotionManager (/pixi-vn-live2d/core/classes/CubismMotionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6152

Handles the motion playback for Live2D models.
Responsible for loading, playing, and managing motion states and audio.

## Emits [#emits]

[MotionManagerEvents](/pixi-vn-live2d/core/interfaces/MotionManagerEvents)

## Extends [#extends]

* [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)\<`CubismMotion`, `CubismSpec.Motion`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismMotionManager**(`parent`): `CubismMotionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6163

#### Parameters [#parameters]

##### parent [#parent]

[`CubismInternalModel`](/pixi-vn-live2d/core/classes/CubismInternalModel)

#### Returns [#returns]

`CubismMotionManager`

#### Overrides [#overrides]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`constructor`](/pixi-vn-live2d/core/classes/MotionManager#constructor)

## Properties [#properties]

### currentAnalyzer? [#currentanalyzer]

\> `optional` **currentAnalyzer?**: `AnalyserNode`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3434

Analyzer element for the current sound being played.

#### Inherited from [#inherited-from]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentAnalyzer`](/pixi-vn-live2d/core/classes/MotionManager#currentanalyzer)

***

### currentAudio? [#currentaudio]

\> `optional` **currentAudio?**: `Sound`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3429

Audio element of the current motion if a sound file is defined with it.

#### Inherited from [#inherited-from-1]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentAudio`](/pixi-vn-live2d/core/classes/MotionManager#currentaudio)

***

### currentContext? [#currentcontext]

\> `optional` **currentContext?**: `AudioContext`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3439

Context element for the current sound being played.

#### Inherited from [#inherited-from-2]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`currentContext`](/pixi-vn-live2d/core/classes/MotionManager#currentcontext)

***

### definitions [#definitions]

\> `abstract` `readonly` **definitions**: `Partial`\<`Record`\<`string`, `CubismSpec.Motion`\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6153

Motion definitions copied from ModelSettings.

#### Overrides [#overrides-1]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`definitions`](/pixi-vn-live2d/core/classes/MotionManager#definitions)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3449

Flags whether the instance has been destroyed.

#### Inherited from [#inherited-from-3]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`destroyed`](/pixi-vn-live2d/core/classes/MotionManager#destroyed)

***

### expressionManager? [#expressionmanager]

\> `abstract` `optional` **expressionManager?**: [`CubismExpressionManager`](/pixi-vn-live2d/core/classes/CubismExpressionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6160

Expression manager for handling model expressions.
Can be undefined if the settings define no expression.

#### Overrides [#overrides-2]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`expressionManager`](/pixi-vn-live2d/core/classes/MotionManager#expressionmanager)

***

### eyeBlinkIds [#eyeblinkids]

\> **eyeBlinkIds**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6161

***

### groups [#groups]

\> `abstract` `readonly` **groups**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6154

Motion groups with specific internal usages. Includes at least the 'idle' field.

#### idle [#idle]

\> `readonly` **idle**: `"Idle"`

#### Overrides [#overrides-3]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`groups`](/pixi-vn-live2d/core/classes/MotionManager#groups)

***

### lipSyncIds [#lipsyncids]

\> **lipSyncIds**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6162

***

### motionDataType [#motiondatatype]

\> `abstract` `readonly` **motionDataType**: `"arraybuffer"` = `"arraybuffer"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6157

Indicates the content type of the motion files, varies in different Cubism versions.
Used as `xhr.responseType`.

#### Overrides [#overrides-4]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionDataType`](/pixi-vn-live2d/core/classes/MotionManager#motiondatatype)

***

### motionGroups [#motiongroups]

\> **motionGroups**: `Partial`\<`Record`\<`string`, (`Motion` | `undefined` | `null`)\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3419

The Motions. The structure is the same as [definitions](#definitions), initially each group contains
an empty array, which means all motions will be `undefined`. When a Motion has been loaded,
it'll fill the place in which it should be; when it fails to load, the place will be filled
with `null`.

#### Inherited from [#inherited-from-4]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionGroups`](/pixi-vn-live2d/core/classes/MotionManager#motiongroups)

***

### parent [#parent-1]

\> **parent**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3454

Reference to the parent InternalModel.

#### Inherited from [#inherited-from-5]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`parent`](/pixi-vn-live2d/core/classes/MotionManager#parent)

***

### playing [#playing]

\> **playing**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3444

Flags whether there is a motion currently playing.

#### Inherited from [#inherited-from-6]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`playing`](/pixi-vn-live2d/core/classes/MotionManager#playing)

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `CubismMotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6158

***

### settings [#settings]

\> `readonly` **settings**: [`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6159

The ModelSettings reference.

#### Overrides [#overrides-5]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`settings`](/pixi-vn-live2d/core/classes/MotionManager#settings)

***

### state [#state]

\> **state**: [`MotionState`](/pixi-vn-live2d/core/classes/MotionState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3424

Maintains the state of this MotionManager.

#### Inherited from [#inherited-from-7]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`state`](/pixi-vn-live2d/core/classes/MotionManager#state)

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3378

Tag for logging.

#### Inherited from [#inherited-from-8]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`tag`](/pixi-vn-live2d/core/classes/MotionManager#tag)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-9]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`prefixed`](/pixi-vn-live2d/core/classes/MotionManager#prefixed)

## Methods [#methods]

### \_startMotion() [#_startmotion]

\> `abstract` `protected` **\_startMotion**(`motion`, `onFinish?`, `ignoreParamIds?`, `loop?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6166

Starts the Motion.

#### Parameters [#parameters-1]

##### motion [#motion]

`CubismMotion`

The Motion to start.

##### onFinish? [#onfinish]

(`motion`) => `void`

Optional callback when finished.

##### ignoreParamIds? [#ignoreparamids]

`string`\[]

The ids to be ignored.

##### loop? [#loop]

`boolean`

Whether the motion should loop.

#### Returns [#returns-1]

`number`

An ID or token for the motion.

#### Overrides [#overrides-6]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`_startMotion`](/pixi-vn-live2d/core/classes/MotionManager#_startmotion)

***

### \_stopAllMotions() [#_stopallmotions]

\> `abstract` `protected` **\_stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6167

Stops all playing motions.

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-7]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`_stopAllMotions`](/pixi-vn-live2d/core/classes/MotionManager#_stopallmotions)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-10]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`addListener`](/pixi-vn-live2d/core/classes/MotionManager#addlistener)

***

### createMotion() [#createmotion]

\> `abstract` **createMotion**(`data`, `group`, `definition`): `CubismMotion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6168

Creates a Motion from the data.

#### Parameters [#parameters-3]

##### data [#data]

`ArrayBuffer`

Content of the motion file. The format must be consistent with [MotionManager#motionDataType](/pixi-vn-live2d/core/classes/MotionManager#motiondatatype).

##### group [#group]

`string`

The motion group.

##### definition [#definition]

`Motion`

The motion definition.

#### Returns [#returns-4]

`CubismMotion`

The created Motion.

#### Overrides [#overrides-8]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`createMotion`](/pixi-vn-live2d/core/classes/MotionManager#createmotion)

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6173

Destroys the instance and releases all resources.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[MotionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#destroy)

#### Overrides [#overrides-9]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`destroy`](/pixi-vn-live2d/core/classes/MotionManager#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-11]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`emit`](/pixi-vn-live2d/core/classes/MotionManager#emit)

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-12]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`eventNames`](/pixi-vn-live2d/core/classes/MotionManager#eventnames)

***

### getMotionAndApplyExpression() [#getmotionandapplyexpression]

\> `protected` **getMotionAndApplyExpression**(`group`, `index`, `expression?`): `Promise`\<`unknown`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3637

Loads a motion and applies the given expression with FORCE priority.

#### Parameters [#parameters-5]

##### group [#group-1]

`string`

The motion group.

##### index [#index]

`number`

The motion index.

##### expression? [#expression]

`string` | `number`

Expression to apply (optional).

#### Returns [#returns-8]

`Promise`\<`unknown`>

The loaded motion, or null if not started.

#### Inherited from [#inherited-from-13]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionAndApplyExpression`](/pixi-vn-live2d/core/classes/MotionManager#getmotionandapplyexpression)

***

### getMotionFile() [#getmotionfile]

\> `abstract` **getMotionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6169

Retrieves the motion's file path by its definition.

#### Parameters [#parameters-6]

##### definition [#definition-1]

`Motion`

Motion definition.

#### Returns [#returns-9]

`string`

The file path extracted from the given definition. Not resolved.

#### Overrides [#overrides-10]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionFile`](/pixi-vn-live2d/core/classes/MotionManager#getmotionfile)

***

### getMotionName() [#getmotionname]

\> `abstract` `protected` **getMotionName**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6170

Retrieves the motion's name by its definition.

#### Parameters [#parameters-7]

##### definition [#definition-2]

`Motion`

Motion definition.

#### Returns [#returns-10]

`string`

The motion's name.

#### Overrides [#overrides-11]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getMotionName`](/pixi-vn-live2d/core/classes/MotionManager#getmotionname)

***

### getSoundFile() [#getsoundfile]

\> `abstract` `protected` **getSoundFile**(`definition`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6171

Retrieves the motion's sound file by its definition.

#### Parameters [#parameters-8]

##### definition [#definition-3]

`Motion`

Motion definition.

#### Returns [#returns-11]

`string` | `undefined`

The motion's sound file, or undefined.

#### Overrides [#overrides-12]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`getSoundFile`](/pixi-vn-live2d/core/classes/MotionManager#getsoundfile)

***

### init() [#init]

\> `protected` **init**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6164

Should be called in the constructor of derived class to initialize options and setup motions.

#### Parameters [#parameters-9]

##### options? [#options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Initialization options for the manager.

#### Returns [#returns-12]

`void`

#### Overrides [#overrides-13]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`init`](/pixi-vn-live2d/core/classes/MotionManager#init)

***

### initializeAudio() [#initializeaudio]

\> `protected` **initializeAudio**(`audio`, `volume`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3490

Initializes audio playback and sets up audio analysis for lipsync.

#### Parameters [#parameters-10]

##### audio [#audio]

`Sound`

The Sound to initialize.

##### volume [#volume]

`number`

The playback volume (0-1).

#### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-14]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`initializeAudio`](/pixi-vn-live2d/core/classes/MotionManager#initializeaudio)

***

### isFinished() [#isfinished]

\> `abstract` **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6165

Checks if the motion playback has finished.

#### Returns [#returns-14]

`boolean`

#### Overrides [#overrides-14]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`isFinished`](/pixi-vn-live2d/core/classes/MotionManager#isfinished)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-11]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-15]

`number`

#### Inherited from [#inherited-from-15]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`listenerCount`](/pixi-vn-live2d/core/classes/MotionManager#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-3]

`T`

#### Returns [#returns-16]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-16]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`listeners`](/pixi-vn-live2d/core/classes/MotionManager#listeners)

***

### loadMotion() [#loadmotion]

\> **loadMotion**(`group`, `index`): `Promise`\<`CubismMotion` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3479

Loads a Motion in a motion group. Errors in this method will not be thrown,
but be emitted with a "motionLoadError" event.

#### Parameters [#parameters-13]

##### group [#group-2]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

#### Returns [#returns-17]

`Promise`\<`CubismMotion` | `undefined`>

Promise that resolves with the Motion, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[MotionManagerEvents.motionLoaded](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaded)

#### Emits [#emits-3]

[MotionManagerEvents.motionLoadError](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaderror)

#### Inherited from [#inherited-from-17]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`loadMotion`](/pixi-vn-live2d/core/classes/MotionManager#loadmotion)

***

### motionLastFrame() [#motionlastframe]

\> `abstract` **motionLastFrame**(`group`, `index`, `expression?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6174

Play the last frame of the given motion, optionally applying an expression.

#### Parameters [#parameters-14]

##### group [#group-3]

`string`

Motion group.

##### index [#index-2]

`number`

Motion index.

##### expression? [#expression-1]

Expression to apply (optional).

###### expression? [#expression-2]

`string` | `number`

#### Returns [#returns-18]

`Promise`\<`boolean`>

Promise resolving to true if successful.

#### Overrides [#overrides-15]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`motionLastFrame`](/pixi-vn-live2d/core/classes/MotionManager#motionlastframe)

***

### mouthSync() [#mouthsync]

\> **mouthSync**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3560

Move the mouth for lipsync.

#### Returns [#returns-19]

`number`

The current lipsync value.

#### Inherited from [#inherited-from-18]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`mouthSync`](/pixi-vn-live2d/core/classes/MotionManager#mouthsync)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-15]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-20]

`this`

#### Inherited from [#inherited-from-19]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`off`](/pixi-vn-live2d/core/classes/MotionManager#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-16]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-20]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`on`](/pixi-vn-live2d/core/classes/MotionManager#on)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-17]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-21]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`once`](/pixi-vn-live2d/core/classes/MotionManager#once)

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-18]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-22]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`removeAllListeners`](/pixi-vn-live2d/core/classes/MotionManager#removealllisteners)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-19]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-23]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`removeListener`](/pixi-vn-live2d/core/classes/MotionManager#removelistener)

***

### setupMotions() [#setupmotions]

\> `protected` **setupMotions**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3469

Sets up motions from the definitions, and preloads them according to the preload strategy.

#### Parameters [#parameters-20]

##### options? [#options-1]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Options controlling which motions to preload.

#### Returns [#returns-25]

`void`

#### Inherited from [#inherited-from-24]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`setupMotions`](/pixi-vn-live2d/core/classes/MotionManager#setupmotions)

***

### speak() [#speak]

\> **speak**(`sound`, `volume?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3502

Only play sound with lip sync.

#### Parameters [#parameters-21]

##### sound [#sound]

`string`

The audio url or base64 content.

##### volume? [#volume-1]

Volume of the sound (0-1).

###### expression? [#expression-3]

`string` | `number`

###### onError? [#onerror]

(`e`) => `void`

###### onFinish? [#onfinish-1]

() => `void`

###### resetExpression? [#resetexpression]

`boolean`

###### volume? [#volume-2]

`number`

#### Returns [#returns-26]

`Promise`\<`boolean`>

Promise that resolves with true if the sound is playing, false otherwise.

#### Inherited from [#inherited-from-25]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`speak`](/pixi-vn-live2d/core/classes/MotionManager#speak)

***

### startMotion() [#startmotion]

\> **startMotion**(`group`, `index`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3525

Starts a motion with the given priority.

#### Parameters [#parameters-22]

##### group [#group-4]

`string`

The motion group.

##### index [#index-3]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: NORMAL (2).

##### sound? [#sound-1]

[`MotionStartOptions`](/pixi-vn-live2d/core/interfaces/MotionStartOptions)

The audio url or base64 content.

#### Returns [#returns-27]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

#### Inherited from [#inherited-from-26]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`startMotion`](/pixi-vn-live2d/core/classes/MotionManager#startmotion)

***

### startRandomMotion() [#startrandommotion]

\> **startRandomMotion**(`group`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3540

Starts a random Motion as given priority.

#### Parameters [#parameters-23]

##### group [#group-5]

`string`

The motion group.

##### priority? [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: IDLE (1).

##### sound? [#sound-2]

[`MotionStartRandomOptions`](/pixi-vn-live2d/core/type-aliases/MotionStartRandomOptions)

The audio url or base64 content.

#### Returns [#returns-28]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

#### Inherited from [#inherited-from-27]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`startRandomMotion`](/pixi-vn-live2d/core/classes/MotionManager#startrandommotion)

***

### stopAllMotions() [#stopallmotions]

\> **stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3548

Stops all playing motions as well as the sound.

#### Returns [#returns-29]

`void`

#### Inherited from [#inherited-from-28]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`stopAllMotions`](/pixi-vn-live2d/core/classes/MotionManager#stopallmotions)

***

### stopSpeaking() [#stopspeaking]

\> **stopSpeaking**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3544

Stops current audio playback and lipsync.

#### Returns [#returns-30]

`void`

#### Inherited from [#inherited-from-29]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`stopSpeaking`](/pixi-vn-live2d/core/classes/MotionManager#stopspeaking)

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3555

Updates parameters of the core model.

#### Parameters [#parameters-24]

##### model [#model]

`object`

The core model.

##### now [#now]

`number`

Current time in milliseconds.

#### Returns [#returns-31]

`boolean`

True if the parameters have been actually updated.

#### Inherited from [#inherited-from-30]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`update`](/pixi-vn-live2d/core/classes/MotionManager#update)

***

### updateParameters() [#updateparameters]

\> `abstract` `protected` **updateParameters**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6172

Updates parameters of the core model.

#### Parameters [#parameters-25]

##### model [#model-1]

`CubismModel`

The core model.

##### now [#now-1]

`number`

Current time in milliseconds.

#### Returns [#returns-32]

`boolean`

True if the parameters have been actually updated.

#### Overrides [#overrides-16]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager).[`updateParameters`](/pixi-vn-live2d/core/classes/MotionManager#updateparameters)


# Class: CubismParallelMotionManager (/pixi-vn-live2d/core/classes/CubismParallelMotionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6179

## Extends [#extends]

* `ParallelMotionManager`\<`CubismMotion`, `CubismSpec.Motion`>

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CubismParallelMotionManager**(`parent`): `CubismParallelMotionManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6182

#### Parameters [#parameters]

##### parent [#parent]

[`CubismInternalModel`](/pixi-vn-live2d/core/classes/CubismInternalModel)

#### Returns [#returns]

`CubismParallelMotionManager`

#### Overrides [#overrides]

`ParallelMotionManager<CubismMotion, CubismSpec.Motion>.constructor`

## Properties [#properties]

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:776

Flags the instances has been destroyed.

#### Inherited from [#inherited-from]

`ParallelMotionManager.destroyed`

***

### manager [#manager]

\> **manager**: [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:760

#### Inherited from [#inherited-from-1]

`ParallelMotionManager.manager`

***

### parent [#parent-1]

\> `readonly` **parent**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:777

#### Inherited from [#inherited-from-2]

`ParallelMotionManager.parent`

***

### playing [#playing]

\> **playing**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:772

Flags there's a motion playing.

#### Inherited from [#inherited-from-3]

`ParallelMotionManager.playing`

***

### queueManager [#queuemanager]

\> `readonly` **queueManager**: `CubismMotionQueueManager`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6180

***

### settings [#settings]

\> `readonly` **settings**: [`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6181

The ModelSettings reference.

#### Overrides [#overrides-1]

`ParallelMotionManager.settings`

***

### state [#state]

\> **state**: [`MotionState`](/pixi-vn-live2d/core/classes/MotionState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:768

Maintains the state of this MotionManager.

#### Inherited from [#inherited-from-4]

`ParallelMotionManager.state`

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:759

Tag for logging.

#### Inherited from [#inherited-from-5]

`ParallelMotionManager.tag`

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-6]

`ParallelMotionManager.prefixed`

## Methods [#methods]

### \_startMotion() [#_startmotion]

\> `protected` **\_startMotion**(`motion`, `onFinish?`, `ignoreParamIds?`, `loop?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6185

Starts the Motion.

#### Parameters [#parameters-1]

##### motion [#motion]

`CubismMotion`

##### onFinish? [#onfinish]

(`motion`) => `void`

##### ignoreParamIds? [#ignoreparamids]

`string`\[]

##### loop? [#loop]

`boolean`

#### Returns [#returns-1]

`number`

#### Overrides [#overrides-2]

`ParallelMotionManager._startMotion`

***

### \_stopAllMotions() [#_stopallmotions]

\> `protected` **\_stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6186

Stops all playing motions.

#### Returns [#returns-2]

`void`

#### Overrides [#overrides-3]

`ParallelMotionManager._stopAllMotions`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-7]

`ParallelMotionManager.addListener`

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6189

Destroys the instance.

#### Returns [#returns-4]

`void`

#### Emits [#emits]

[MotionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#destroy)

#### Overrides [#overrides-4]

`ParallelMotionManager.destroy`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-3]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-8]

`ParallelMotionManager.emit`

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-6]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-9]

`ParallelMotionManager.eventNames`

***

### getMotionName() [#getmotionname]

\> `protected` **getMotionName**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6188

Retrieves the motion's name by its definition.

#### Parameters [#parameters-4]

##### definition [#definition]

`Motion`

#### Returns [#returns-7]

`string`

The motion's name.

#### Overrides [#overrides-5]

`ParallelMotionManager.getMotionName`

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6183

#### Returns [#returns-8]

`void`

***

### isFinished() [#isfinished]

\> **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6184

Checks if the motion playback has finished.

#### Returns [#returns-9]

`boolean`

#### Overrides [#overrides-6]

`ParallelMotionManager.isFinished`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-5]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-10]

`number`

#### Inherited from [#inherited-from-10]

`ParallelMotionManager.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-6]

##### event [#event-3]

`T`

#### Returns [#returns-11]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-11]

`ParallelMotionManager.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-7]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-12]

`this`

#### Inherited from [#inherited-from-12]

`ParallelMotionManager.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-8]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-13]

`this`

#### Inherited from [#inherited-from-13]

`ParallelMotionManager.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-9]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-14]

`this`

#### Inherited from [#inherited-from-14]

`ParallelMotionManager.once`

***

### playMotionLastFrame() [#playmotionlastframe]

\> **playMotionLastFrame**(`group`, `index`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6190

#### Parameters [#parameters-10]

##### group [#group]

`string`

##### index [#index]

`number`

#### Returns [#returns-15]

`Promise`\<`boolean`>

#### Overrides [#overrides-7]

`ParallelMotionManager.playMotionLastFrame`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-11]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-16]

`this`

#### Inherited from [#inherited-from-15]

`ParallelMotionManager.removeAllListeners`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-17]

`this`

#### Inherited from [#inherited-from-16]

`ParallelMotionManager.removeListener`

***

### startMotion() [#startmotion]

\> **startMotion**(`group`, `index`, `priority?`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:788

Starts a motion as given priority.

#### Parameters [#parameters-13]

##### group [#group-1]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. default: 2 (NORMAL)

##### options? [#options]

`string`\[] | [`ParallelMotionStartOptions`](/pixi-vn-live2d/core/interfaces/ParallelMotionStartOptions)

#### Returns [#returns-18]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-17]

`ParallelMotionManager.startMotion`

***

### startRandomMotion() [#startrandommotion]

\> **startRandomMotion**(`group`, `priority?`, `loop?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:796

Starts a random Motion as given priority.

#### Parameters [#parameters-14]

##### group [#group-2]

`string`

The motion group.

##### priority? [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. (default: 1 `IDLE`)

##### loop? [#loop-1]

[`ParallelMotionStartRandomOptions`](/pixi-vn-live2d/core/type-aliases/ParallelMotionStartRandomOptions)

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.

#### Returns [#returns-19]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-18]

`ParallelMotionManager.startRandomMotion`

***

### stopAllMotions() [#stopallmotions]

\> **stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:800

Stops all playing motions as well as the sound.

#### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-19]

`ParallelMotionManager.stopAllMotions`

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:807

Updates parameters of the core model.

#### Parameters [#parameters-15]

##### model [#model]

`object`

The core model.

##### now [#now]

`number`

Current time in milliseconds.

#### Returns [#returns-21]

`boolean`

True if the parameters have been actually updated.

#### Inherited from [#inherited-from-20]

`ParallelMotionManager.update`

***

### updateParameters() [#updateparameters]

\> `protected` **updateParameters**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6187

Updates parameters of the core model.

#### Parameters [#parameters-16]

##### model [#model-1]

`CubismModel`

The core model.

##### now [#now-1]

`number`

Current time in milliseconds.

#### Returns [#returns-22]

`boolean`

True if the parameters have been actually updated.

#### Overrides [#overrides-8]

`ParallelMotionManager.updateParameters`


# Abstract Class: ExpressionManager<Expression, ExpressionSpec> (/pixi-vn-live2d/core/classes/ExpressionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3780

Abstract expression manager.

## Emits [#emits]

[ExpressionManagerEvents](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)

## Extends [#extends]

* `EventEmitter`\<keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)>

## Extended by [#extended-by]

* [`CubismLegacyExpressionManager`](/pixi-vn-live2d/core/classes/CubismLegacyExpressionManager)
* [`CubismExpressionManager`](/pixi-vn-live2d/core/classes/CubismExpressionManager)

## Type Parameters [#type-parameters]

### Expression [#expression]

`Expression` = `unknown`

### ExpressionSpec [#expressionspec]

`ExpressionSpec` = `unknown`

## Constructors [#constructors]

### Constructor [#constructor]

\> `protected` **new ExpressionManager**\<`Expression`, `ExpressionSpec`>(`settings`, `_options?`): `ExpressionManager`\<`Expression`, `ExpressionSpec`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3821

#### Parameters [#parameters]

##### settings [#settings]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

##### \_options? [#_options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

#### Returns [#returns]

`ExpressionManager`\<`Expression`, `ExpressionSpec`>

#### Overrides [#overrides]

`EventEmitter<keyof ExpressionManagerEvents>.constructor`

## Properties [#properties]

### currentExpression [#currentexpression]

\> **currentExpression**: `Expression`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3812

Current Expression. This will not be overwritten by [ExpressionManager#defaultExpression](#defaultexpression).

***

### defaultExpression [#defaultexpression]

\> **defaultExpression**: `Expression`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3808

An empty Expression to reset all the expression parameters.

***

### definitions [#definitions]

\> `abstract` `readonly` **definitions**: `ExpressionSpec`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3793

Expression definitions copied from ModelSettings.

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3820

Flags the instance has been destroyed.

***

### expressionDataType [#expressiondatatype]

\> `readonly` **expressionDataType**: `XMLHttpRequestResponseType`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3785

Indicates the content type used when loading expressions.

#### Default [#default]

```ts
"json"
```

***

### expressions [#expressions]

\> **expressions**: (`Expression` | `null` | `undefined`)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3804

The Expressions. The structure is the same as [definitions](#definitions), initially there's only
an empty array, which means all expressions will be `undefined`. When an Expression has
been loaded, it'll fill the place in which it should be; when it fails to load,
the place will be filled with `null`.

***

### reserveExpressionIndex [#reserveexpressionindex]

\> **reserveExpressionIndex**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3816

The pending Expression.

***

### settings [#settings-1]

\> `readonly` **settings**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3797

The ModelSettings reference.

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3789

Tag for logging.

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from]

`EventEmitter.prefixed`

## Methods [#methods]

### \_setExpression() [#_setexpression]

\> `abstract` `protected` **\_setExpression**(`motion`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3897

Applies the Expression to the model.

#### Parameters [#parameters-1]

##### motion [#motion]

`Expression`

#### Returns [#returns-1]

`number`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-1]

##### T [#t]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-2]

`this`

#### Inherited from [#inherited-from-1]

`EventEmitter.addListener`

***

### createDefaultExpression() [#createdefaultexpression]

\> `protected` **createDefaultExpression**(): `Expression`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3829

Creates the default expression instance used for resets.

#### Returns [#returns-3]

`Expression`

***

### createExpression() [#createexpression]

\> `abstract` **createExpression**(`data`, `definition`): `Expression`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3893

Creates an Expression from the data.

#### Parameters [#parameters-3]

##### data [#data]

`object`

Content of the expression file.

##### definition [#definition]

`ExpressionSpec` | `undefined`

The expression definition. Can be undefined in order to create [ExpressionManager#defaultExpression](#defaultexpression).

#### Returns [#returns-4]

`Expression`

The created Expression.

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3872

Destroys the instance.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[ExpressionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-1]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-2]

`EventEmitter.emit`

***

### eventNames() [#eventnames]

\> **eventNames**(): keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>\[]

#### Inherited from [#inherited-from-3]

`EventEmitter.eventNames`

***

### getExpressionFile() [#getexpressionfile]

\> `abstract` **getExpressionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3886

Retrieves the expression's file path by its definition.

#### Parameters [#parameters-5]

##### definition [#definition-1]

`ExpressionSpec`

#### Returns [#returns-8]

`string`

The file path extracted from given definition. Not resolved.

***

### getExpressionIndex() [#getexpressionindex]

\> `abstract` **getExpressionIndex**(`name`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3881

Retrieves the expression's index by its name.

#### Parameters [#parameters-6]

##### name [#name]

`string`

#### Returns [#returns-9]

`number`

The index. `-1` if not found.

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3825

Should be called in the constructor of derived class.

#### Returns [#returns-10]

`void`

***

### isFinished() [#isfinished]

\> `abstract` **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3876

Checks if the expression playback has finished.

#### Returns [#returns-11]

`boolean`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-7]

##### event [#event-2]

keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Returns [#returns-12]

`number`

#### Inherited from [#inherited-from-4]

`EventEmitter.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-3]

##### T [#t-2]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-8]

##### event [#event-3]

`T`

#### Returns [#returns-13]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-5]

`EventEmitter.listeners`

***

### loadExpression() [#loadexpression]

\> `protected` **loadExpression**(`index`): `Promise`\<`Expression` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3838

Loads an Expression. Errors in this method will not be thrown,
but be emitted with an "expressionLoadError" event.

#### Parameters [#parameters-9]

##### index [#index]

`number`

Index of the expression in definitions.

#### Returns [#returns-14]

`Promise`\<`Expression` | `undefined`>

Promise that resolves with the Expression, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[ExpressionManagerEvents.expressionLoaded](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaded)

#### Emits [#emits-3]

[ExpressionManagerEvents.expressionLoadError](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents#expressionloaderror)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-4]

##### T [#t-3]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-10]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-15]

`this`

#### Inherited from [#inherited-from-6]

`EventEmitter.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-4]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-11]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-16]

`this`

#### Inherited from [#inherited-from-7]

`EventEmitter.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-5]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-12]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-17]

`this`

#### Inherited from [#inherited-from-8]

`EventEmitter.once`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-13]

##### event? [#event-7]

keyof ExpressionManagerEvents\<never>

#### Returns [#returns-18]

`this`

#### Inherited from [#inherited-from-9]

`EventEmitter.removeAllListeners`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-6]

`T` *extends* keyof [`ExpressionManagerEvents`](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)\<`never`>

#### Parameters [#parameters-14]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-19]

`this`

#### Inherited from [#inherited-from-10]

`EventEmitter.removeListener`

***

### resetExpression() [#resetexpression]

\> **resetExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3852

Resets model's expression using [ExpressionManager#defaultExpression](#defaultexpression).

#### Returns [#returns-20]

`void`

***

### restoreExpression() [#restoreexpression]

\> **restoreExpression**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3856

Restores model's expression to [currentExpression](#currentexpression).

#### Returns [#returns-21]

`void`

***

### setExpression() [#setexpression]

\> **setExpression**(`index`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3862

Sets an Expression.

#### Parameters [#parameters-15]

##### index [#index-1]

`string` | `number`

Either the index, or the name of the expression.

#### Returns [#returns-22]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

***

### setRandomExpression() [#setrandomexpression]

\> **setRandomExpression**(): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3848

Sets a random Expression that differs from current one.

#### Returns [#returns-23]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

***

### stopAllExpressions() [#stopallexpressions]

\> `abstract` `protected` **stopAllExpressions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3901

Cancels expression playback.

#### Returns [#returns-24]

`void`

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3867

Updates parameters of the core model.

#### Parameters [#parameters-16]

##### model [#model]

`object`

##### now [#now]

`number`

#### Returns [#returns-25]

`boolean`

True if the parameters are actually updated.

***

### updateParameters() [#updateparameters]

\> `abstract` `protected` **updateParameters**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3906

Updates parameters of the core model.

#### Parameters [#parameters-17]

##### model [#model-1]

`object`

##### now [#now-1]

`number`

#### Returns [#returns-26]

`boolean`

True if the parameters are actually updated.


# Class: FileLoader (/pixi-vn-live2d/core/classes/FileLoader)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4780

Experimental loader to load resources from uploaded files.

This loader relies on
[webkitRelativePath](https://developer.mozilla.org/en-US/docs/Web/API/File/webkitRelativePath)
to recognize the file path.

Though named as a "Loader", this class has nothing to do with Live2DLoader,
it only contains a middleware for the Live2DFactory.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new FileLoader**(): `FileLoader`

#### Returns [#returns]

`FileLoader`

## Properties [#properties]

### factory [#factory]

\> `static` **factory**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4800

Middleware for Live2DFactory.

***

### filesMap [#filesmap]

\> `static` **filesMap**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4785

Stores all the object URLs of uploaded files.

#### Index Signature [#index-signature]

\[`settingsFileURL`: `string`]: `object`

***

### live2dFactory? [#live2dfactory]

\> `static` `optional` **live2dFactory?**: *typeof* [`Live2DFactory`](/pixi-vn-live2d/core/classes/Live2DFactory)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4781

## Methods [#methods]

### createSettings() [#createsettings]

\> `static` **createSettings**(`files`): `Promise`\<[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4809

Creates a ModelSettings by given files.

#### Parameters [#parameters]

##### files [#files]

`File`\[]

#### Returns [#returns-1]

`Promise`\<[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)>

Promise that resolves with the created ModelSettings.

***

### readText() [#readtext]

\> `static` **readText**(`file`): `Promise`\<`string`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4813

Reads a file as text in UTF-8.

#### Parameters [#parameters-1]

##### file [#file]

`File`

#### Returns [#returns-2]

`Promise`\<`string`>

***

### resolveURL() [#resolveurl]

\> `static` **resolveURL**(`settingsURL`, `filePath`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4796

Resolves the path of a resource file to the object URL.

#### Parameters [#parameters-2]

##### settingsURL [#settingsurl]

`string`

Object URL of the settings file.

##### filePath [#filepath]

`string`

Resource file path.

#### Returns [#returns-3]

`string`

Resolved object URL.

***

### upload() [#upload]

\> `static` **upload**(`files`, `settings`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4804

Consumes the files by storing their object URLs. Files not defined in the settings will be ignored.

#### Parameters [#parameters-3]

##### files [#files-1]

`File`\[]

##### settings [#settings]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

#### Returns [#returns-4]

`void`


# Class: FocusController (/pixi-vn-live2d/core/classes/FocusController)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:721

Interpolates the transition of focus position.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new FocusController**(): `FocusController`

#### Returns [#returns]

`FocusController`

## Properties [#properties]

### targetX [#targetx]

\> **targetX**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:723

The focus position.

***

### targetY [#targety]

\> **targetY**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:725

The focus position.

***

### vx [#vx]

\> **vx**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:731

Current velocity.

***

### vy [#vy]

\> **vy**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:733

Current velocity.

***

### x [#x]

\> **x**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:727

Current position.

***

### y [#y]

\> **y**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:729

Current position.

## Methods [#methods]

### focus() [#focus]

\> **focus**(`x`, `y`, `instant?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:740

Sets the focus position.

#### Parameters [#parameters]

##### x [#x-1]

`number`

X position in range `[-1, 1]`.

##### y [#y-1]

`number`

Y position in range `[-1, 1]`.

##### instant? [#instant]

`boolean`

Should the focus position be instantly applied.

#### Returns [#returns-1]

`void`

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:745

Updates the interpolation.

#### Parameters [#parameters-1]

##### dt [#dt]

`number`

Delta time in milliseconds.

#### Returns [#returns-2]

`void`


# Abstract Class: InternalModel (/pixi-vn-live2d/core/classes/InternalModel)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3145

A wrapper that manages the states of a Live2D core model, and delegates all operations to it.

## Emits [#emits]

[InternalModelEvents](/pixi-vn-live2d/core/interfaces/InternalModelEvents)

## Extends [#extends]

* `EventEmitter`

## Extended by [#extended-by]

* [`CubismLegacyInternalModel`](/pixi-vn-live2d/core/classes/CubismLegacyInternalModel)
* [`CubismInternalModel`](/pixi-vn-live2d/core/classes/CubismInternalModel)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new InternalModel**(): `InternalModel`

#### Returns [#returns]

`InternalModel`

#### Inherited from [#inherited-from]

`EventEmitter.constructor`

## Properties [#properties]

### coreModel [#coremodel]

\> `abstract` `readonly` **coreModel**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3149

The managed Live2D core model.

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3203

Flags this instance has been destroyed.

***

### drawingMatrix [#drawingmatrix]

\> **drawingMatrix**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3182

The final matrix to draw the model.

***

### focusController [#focuscontroller]

\> **focusController**: [`FocusController`](/pixi-vn-live2d/core/classes/FocusController)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3152

***

### height [#height]

\> `readonly` **height**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3174

Canvas height of the model, scaled by the `height` of the model's layout.

***

### hitAreas [#hitareas]

\> **hitAreas**: `Record`\<`string`, [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3186

The hit area definitions, keyed by their names.

***

### localTransform [#localtransform]

\> **localTransform**: `Matrix`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3178

Local transformation, calculated from the model's layout.

***

### motionManager [#motionmanager]

\> `abstract` **motionManager**: [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3153

***

### options [#options]

\> `abstract` `readonly` **options**: [`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3151

***

### originalHeight [#originalheight]

\> `readonly` **originalHeight**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3166

Original canvas height of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

***

### originalWidth [#originalwidth]

\> `readonly` **originalWidth**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3161

Original canvas width of the model. Note this doesn't represent the model's real size,
as the model can overflow from its canvas.

***

### parallelMotionManager [#parallelmotionmanager]

\> `abstract` **parallelMotionManager**: `ParallelMotionManager`\<`Live2DMotion` | `CubismMotion`, `never`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3154

***

### physics? [#physics]

\> `optional` **physics?**: `unknown`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3156

***

### pose? [#pose]

\> `optional` **pose?**: `unknown`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3155

***

### settings [#settings]

\> `abstract` `readonly` **settings**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3150

***

### textureFlipY [#textureflipy]

\> **textureFlipY**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3190

Flags whether `gl.UNPACK_FLIP_Y_WEBGL` should be enabled when binding the textures.

***

### viewport [#viewport]

\> **viewport**: \[`number`, `number`, `number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3194

WebGL viewport when drawing the model. The format is `[x, y, width, height]`.

***

### width [#width]

\> `readonly` **width**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3170

Canvas width of the model, scaled by the `width` of the model's layout.

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-1]

`EventEmitter.prefixed`

## Methods [#methods]

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-1]

`this`

#### Inherited from [#inherited-from-2]

`EventEmitter.addListener`

***

### bindTexture() [#bindtexture]

\> `abstract` **bindTexture**(`index`, `texture`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3315

Binds a texture to the model. The index must be the same as that of this texture
in the [ModelSettings.textures](/pixi-vn-live2d/core/classes/ModelSettings#textures) array.

#### Parameters [#parameters-1]

##### index [#index]

`number`

##### texture [#texture]

`WebGLTexture`

#### Returns [#returns-2]

`void`

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3253

Destroys the model and all related resources.

#### Returns [#returns-3]

`void`

#### Emits [#emits-1]

\`InternalModelEvents.destroy\` | destroy

***

### draw() [#draw]

\> `abstract` **draw**(`gl`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3319

Draws the model.

#### Parameters [#parameters-2]

##### gl [#gl]

`WebGLRenderingContext`

#### Returns [#returns-4]

`void`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-1]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-3]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-5]

`boolean`

#### Inherited from [#inherited-from-3]

`EventEmitter.emit`

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-6]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-4]

`EventEmitter.eventNames`

***

### extendParallelMotionManager() [#extendparallelmotionmanager]

\> `abstract` **extendParallelMotionManager**(`managerCount`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3324

Add parallel motion manager.

#### Parameters [#parameters-4]

##### managerCount [#managercount]

`number`

Count of parallel motion managers.

#### Returns [#returns-7]

`void`

***

### getDrawableBounds() [#getdrawablebounds]

\> **getDrawableBounds**(`index`, `bounds?`): `Bounds`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3237

Gets a drawable's bounds.

#### Parameters [#parameters-5]

##### index [#index-1]

`number`

Index of the drawable.

##### bounds? [#bounds]

`Bounds`

Object to store the output values.

#### Returns [#returns-8]

`Bounds`

The bounds in model canvas space.

***

### getDrawableIDs() [#getdrawableids]

\> `abstract` **getDrawableIDs**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3293

Gets all the drawables' IDs.

#### Returns [#returns-9]

`string`\[]

IDs.

***

### getDrawableIndex() [#getdrawableindex]

\> `abstract` **getDrawableIndex**(`id`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3298

Finds the index of a drawable by its ID.

#### Parameters [#parameters-6]

##### id [#id]

`string`

#### Returns [#returns-10]

`number`

The index.

***

### getDrawableVertices() [#getdrawablevertices]

\> `abstract` **getDrawableVertices**(`index`): `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3304

Gets a drawable's vertices.

#### Parameters [#parameters-7]

##### index [#index-2]

`string` | `number`

Either the index or the ID of the drawable.

#### Returns [#returns-11]

`Float32Array`

#### Throws [#throws]

Error when the drawable cannot be found.

***

### getHitAreaDefs() [#gethitareadefs]

\> `abstract` `protected` **getHitAreaDefs**(): [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3275

Gets all the hit area definitions.

#### Returns [#returns-12]

[`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Normalized definitions.

***

### getLayout() [#getlayout]

\> `abstract` `protected` **getLayout**(): [`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3288

Gets the layout definition.

#### Returns [#returns-13]

[`CommonLayout`](/pixi-vn-live2d/core/interfaces/CommonLayout)

Normalized definition.

***

### getSize() [#getsize]

\> `abstract` `protected` **getSize**(): \[`number`, `number`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3280

Gets the model's original canvas size.

#### Returns [#returns-14]

\[`number`, `number`]

`[width, height]`

***

### hitTest() [#hittest]

\> **hitTest**(`x`, `y`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3222

Hit-test on the model.

#### Parameters [#parameters-8]

##### x [#x]

`number`

Position in model canvas.

##### y [#y]

`number`

Position in model canvas.

#### Returns [#returns-15]

`string`\[]

The names of the *hit* hit areas. Can be empty if none is hit.

***

### init() [#init]

\> `protected` **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3207

Should be called in the constructor of derived class.

#### Returns [#returns-16]

`void`

***

### isHit() [#ishit]

\> **isHit**(`hitAreaName`, `x`, `y`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3230

Hit-test for a single hit area.

#### Parameters [#parameters-9]

##### hitAreaName [#hitareaname]

`string`

The hit area's name.

##### x [#x-1]

`number`

Position in model canvas.

##### y [#y-1]

`number`

Position in model canvas.

#### Returns [#returns-17]

`boolean`

True if hit.

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-10]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-18]

`number`

#### Inherited from [#inherited-from-5]

`EventEmitter.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-11]

##### event [#event-3]

`T`

#### Returns [#returns-19]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-6]

`EventEmitter.listeners`

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-3]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-20]

`this`

#### Inherited from [#inherited-from-7]

`EventEmitter.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-13]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-8]

`EventEmitter.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-14]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-9]

`EventEmitter.once`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-15]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-10]

`EventEmitter.removeAllListeners`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-16]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-11]

`EventEmitter.removeListener`

***

### setupHitAreas() [#setuphitareas]

\> `protected` **setupHitAreas**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3215

Sets up the hit areas by their definitions in settings.

#### Returns [#returns-25]

`void`

***

### setupLayout() [#setuplayout]

\> `protected` **setupLayout**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3211

Sets up the model's size and local transform by the model's layout.

#### Returns [#returns-26]

`void`

***

### update() [#update]

\> **update**(`dt`, `_now`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3248

Updates the model's parameters.

#### Parameters [#parameters-17]

##### dt [#dt]

`number`

Elapsed time in milliseconds from last frame.

##### \_now [#_now]

`number`

Current time in milliseconds.

#### Returns [#returns-27]

`void`

***

### updateMotions() [#updatemotions]

\> `protected` **updateMotions**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3270

Updates all active motions for the model and emits lifecycle events.

This method coordinates the update cycle for both primary and parallel motion managers,
ensuring all animations are synchronized with the current timestamp. It emits events
before and after the update process, allowing external listeners to hook into the motion
lifecycle. The return value indicates whether any motion was actively updated during this cycle.

#### Parameters [#parameters-18]

##### model [#model]

`object`

The model instance to apply motion updates to.

##### now [#now]

`number`

The current timestamp (in milliseconds) used to calculate motion progress.

#### Returns [#returns-28]

`boolean`

Returns `true` if any motion (primary or parallel) was updated; `false` otherwise.

#### Emits [#emits-2]

beforeMotionUpdate - Triggered before any motion updates are processed.

#### Emits [#emits-3]

afterMotionUpdate - Triggered after all motion updates are completed.

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`transform`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3242

Updates the model's transform.

#### Parameters [#parameters-19]

##### transform [#transform]

`Matrix`

The world transform.

#### Returns [#returns-29]

`void`

***

### updateWebGLContext() [#updatewebglcontext]

\> `abstract` **updateWebGLContext**(`gl`, `glContextID`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3310

Updates WebGL context bound to this model.

#### Parameters [#parameters-20]

##### gl [#gl-1]

`WebGLRenderingContext`

WebGL context.

##### glContextID [#glcontextid]

`number`

Unique ID for given WebGL context.

#### Returns [#returns-30]

`void`


# Class: Live2DExpression (/pixi-vn-live2d/core/classes/Live2DExpression)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5011

## Extends [#extends]

* `AMotion`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DExpression**(`json`): `Live2DExpression`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5013

#### Parameters [#parameters]

##### json [#json]

[`ExpressionJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ExpressionJSON)

#### Returns [#returns]

`Live2DExpression`

#### Overrides [#overrides]

`AMotion.constructor`

## Properties [#properties]

### params [#params]

\> `readonly` **params**: `object`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5012

#### calc? [#calc]

\> `optional` **calc?**: `"add"` | `"set"` | `"mult"`

#### def? [#def]

\> `optional` **def?**: `number`

#### id [#id]

\> **id**: `string`

#### val [#val]

\> **val**: `number`

## Methods [#methods]

### getDurationMSec() [#getdurationmsec]

\> **getDurationMSec**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:41

#### Returns [#returns-1]

`number`

#### Inherited from [#inherited-from]

`AMotion.getDurationMSec`

***

### setFadeIn() [#setfadein]

\> **setFadeIn**(`time`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:37

#### Parameters [#parameters-1]

##### time [#time]

`number`

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-1]

`AMotion.setFadeIn`

***

### setFadeOut() [#setfadeout]

\> **setFadeOut**(`time`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:38

#### Parameters [#parameters-2]

##### time [#time-1]

`number`

#### Returns [#returns-3]

`void`

#### Inherited from [#inherited-from-2]

`AMotion.setFadeOut`

***

### updateParam() [#updateparam]

\> **updateParam**(`model`, `entry`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:39

#### Parameters [#parameters-3]

##### model [#model]

`Live2DModelWebGL`

##### entry [#entry]

[`MotionQueueEnt`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/MotionQueueEnt)

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-3]

`AMotion.updateParam`

***

### updateParamExe() [#updateparamexe]

\> **updateParamExe**(`model`, `time`, `weight`, `_motionQueueEnt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5015

#### Parameters [#parameters-4]

##### model [#model-1]

`Live2DModelWebGL`

##### time [#time-2]

`number`

##### weight [#weight]

`number`

##### \_motionQueueEnt [#_motionqueueent]

`unknown`

#### Returns [#returns-5]

`void`

#### Overrides [#overrides-1]

`AMotion.updateParamExe`


# Class: Live2DEyeBlink (/pixi-vn-live2d/core/classes/Live2DEyeBlink)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5072

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DEyeBlink**(`coreModel`): `Live2DEyeBlink`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5084

#### Parameters [#parameters]

##### coreModel [#coremodel]

`Live2DModelWebGL`

#### Returns [#returns]

`Live2DEyeBlink`

## Properties [#properties]

### blinkInterval [#blinkinterval]

\> **blinkInterval**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5076

***

### closedDuration [#closedduration]

\> **closedDuration**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5078

***

### closedTimer [#closedtimer]

\> **closedTimer**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5082

***

### closingDuration [#closingduration]

\> **closingDuration**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5077

***

### coreModel [#coremodel-1]

\> `readonly` **coreModel**: `Live2DModelWebGL`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5073

***

### eyeParamValue [#eyeparamvalue]

\> **eyeParamValue**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5081

***

### eyeState [#eyestate]

\> **eyeState**: [`EyeState`](/pixi-vn-live2d/core/enumerations/EyeState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5080

***

### leftParam [#leftparam]

\> **leftParam**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5074

***

### nextBlinkTimeLeft [#nextblinktimeleft]

\> **nextBlinkTimeLeft**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5083

***

### openingDuration [#openingduration]

\> **openingDuration**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5079

***

### rightParam [#rightparam]

\> **rightParam**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5075

## Methods [#methods]

### setEyeParams() [#seteyeparams]

\> **setEyeParams**(`value`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5085

#### Parameters [#parameters-1]

##### value [#value]

`number`

#### Returns [#returns-1]

`void`

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5086

#### Parameters [#parameters-2]

##### dt [#dt]

`number`

#### Returns [#returns-2]

`void`


# Class: Live2DFactory (/pixi-vn-live2d/core/classes/Live2DFactory)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4155

Handles all the network load tasks.

* Model creation: requested by [Live2DModel.from](/pixi-vn-live2d/core/classes/Live2DModel#from).
* Motion loading: implements the load method of MotionManager.
* Expression loading: implements the load method of ExpressionManager.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DFactory**(): `Live2DFactory`

#### Returns [#returns]

`Live2DFactory`

## Properties [#properties]

### createInternalModel [#createinternalmodel]

\> `static` **createInternalModel**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4165

***

### expressionTasksMap [#expressiontasksmap]

\> `static` **expressionTasksMap**: `WeakMap`\<[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)\<`unknown`, `unknown`>, (`Promise`\<`any`> | `undefined`)\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4178

Load tasks of each expression.

***

### jsonToSettings [#jsontosettings]

\> `static` **jsonToSettings**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4161

***

### live2DModelMiddlewares [#live2dmodelmiddlewares]

\> `static` **live2DModelMiddlewares**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4169

Middlewares to run through when setting up a Live2DModel.

***

### motionTasksMap [#motiontasksmap]

\> `static` **motionTasksMap**: `WeakMap`\<[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)\<`unknown`, `unknown`>, `Record`\<`string`, (`Promise`\<`any`> | `undefined`)\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4174

load tasks of each motion. The structure of each value in this map
is the same as respective [MotionManager.definitions](/pixi-vn-live2d/core/classes/MotionManager#definitions).

***

### runtimes [#runtimes]

\> `static` **runtimes**: [`Live2DRuntime`](/pixi-vn-live2d/core/interfaces/Live2DRuntime)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4159

All registered runtimes, sorted by versions in descending order.

***

### setupEssentials [#setupessentials]

\> `static` **setupEssentials**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4164

***

### setupOptionals [#setupoptionals]

\> `static` **setupOptionals**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4163

***

### urlToJSON [#urltojson]

\> `static` **urlToJSON**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4160

***

### waitUntilReady [#waituntilready]

\> `static` **waitUntilReady**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DFactoryContext`](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4162

## Methods [#methods]

### findRuntime() [#findruntime]

\> `static` **findRuntime**(`source`): [`Live2DRuntime`](/pixi-vn-live2d/core/interfaces/Live2DRuntime) | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4188

Finds a runtime that matches given source.

#### Parameters [#parameters]

##### source [#source]

`any`

Either a settings JSON object or a ModelSettings instance.

#### Returns [#returns-1]

[`Live2DRuntime`](/pixi-vn-live2d/core/interfaces/Live2DRuntime) | `undefined`

The Live2DRuntime, or undefined if not found.

***

### loadExpression() [#loadexpression]

\> `static` **loadExpression**\<`Expression`, `ExpressionSpec`>(`expressionManager`, `index`): `Promise`\<`Expression` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4213

Loads an Expression and registers the task to [expressionTasksMap](#expressiontasksmap). The task will be automatically
canceled when its owner - the ExpressionManager instance - has been destroyed.

#### Type Parameters [#type-parameters]

##### Expression [#expression]

`Expression`

##### ExpressionSpec [#expressionspec]

`ExpressionSpec`

#### Parameters [#parameters-1]

##### expressionManager [#expressionmanager]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)\<`Expression`, `ExpressionSpec`>

ExpressionManager that owns this Expression.

##### index [#index]

`number`

Index of the Expression.

#### Returns [#returns-2]

`Promise`\<`Expression` | `undefined`>

Promise that resolves with the Expression, or with undefined if it can't be loaded.

***

### loadMotion() [#loadmotion]

\> `static` **loadMotion**\<`Motion`, `MotionSpec`>(`motionManager`, `group`, `index`): `Promise`\<`Motion` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4205

Loads a Motion and registers the task to [motionTasksMap](#motiontasksmap). The task will be automatically
canceled when its owner - the MotionManager instance - has been destroyed.

#### Type Parameters [#type-parameters-1]

##### Motion [#motion]

`Motion`

##### MotionSpec [#motionspec]

`MotionSpec`

#### Parameters [#parameters-2]

##### motionManager [#motionmanager]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)\<`Motion`, `MotionSpec`>

MotionManager that owns this Motion.

##### group [#group]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

#### Returns [#returns-3]

`Promise`\<`Motion` | `undefined`>

Promise that resolves with the Motion, or with undefined if it can't be loaded.

***

### registerRuntime() [#registerruntime]

\> `static` **registerRuntime**(`runtime`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4182

Registers a Live2DRuntime.

#### Parameters [#parameters-3]

##### runtime [#runtime]

[`Live2DRuntime`](/pixi-vn-live2d/core/interfaces/Live2DRuntime)

#### Returns [#returns-4]

`void`

***

### releaseExpressionTasks() [#releaseexpressiontasks]

\> `static` **releaseExpressionTasks**(`expressionManager`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4215

#### Parameters [#parameters-4]

##### expressionManager [#expressionmanager-1]

[`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)

#### Returns [#returns-5]

`void`

***

### releaseMotionTasks() [#releasemotiontasks]

\> `static` **releaseMotionTasks**(`motionManager`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4214

#### Parameters [#parameters-5]

##### motionManager [#motionmanager-1]

[`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager)

#### Returns [#returns-6]

`void`

***

### setupLive2DModel() [#setuplive2dmodel]

\> `static` **setupLive2DModel**\<`IM`>(`live2dModel`, `source`, `options?`): `Promise`\<`void`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4196

Sets up a Live2DModel, populating it with all defined resources.

#### Type Parameters [#type-parameters-2]

##### IM [#im]

`IM` *extends* [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

#### Parameters [#parameters-6]

##### live2dModel [#live2dmodel]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)\<`IM`>

The Live2DModel instance.

##### source [#source-1]

`string` | `object` | `IM`\[`"settings"`]

Can be one of: settings file URL, settings JSON object, ModelSettings instance.

##### options? [#options]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options for the process.

#### Returns [#returns-7]

`Promise`\<`void`>

Promise that resolves when all resources have been loaded, rejects when error occurs.


# Class: Live2DLoader (/pixi-vn-live2d/core/classes/Live2DLoader)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4720

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DLoader**(): `Live2DLoader`

#### Returns [#returns]

`Live2DLoader`

## Properties [#properties]

### middlewares [#middlewares]

\> `static` **middlewares**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DLoaderContext`](/pixi-vn-live2d/core/interfaces/Live2DLoaderContext)>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4721

## Methods [#methods]

### load() [#load]

\> `static` **load**\<`T`>(`context`): `Promise`\<`T`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4726

Loads a resource.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `unknown`

#### Parameters [#parameters]

##### context [#context]

[`Live2DLoaderContext`](/pixi-vn-live2d/core/interfaces/Live2DLoaderContext)

#### Returns [#returns-1]

`Promise`\<`T`>

Promise that resolves with the loaded data in a format that's consistent with the specified `type`.


# Class: Live2DModel<IM> (/pixi-vn-live2d/core/classes/Live2DModel)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4352

A wrapper that allows the Live2D model to be used as a DisplayObject in PixiJS.

```js
const model = await Live2DModel.from('shizuku.model.json');
container.add(model);
```

## Emits [#emits]

[Live2DModelEvents](/pixi-vn-live2d/core/interfaces/Live2DModelEvents)

## Extends [#extends]

* `Container`

## Extended by [#extended-by]

* [`Live2D`](/pixi-vn-live2d/index/classes/Live2D)

## Type Parameters [#type-parameters]

### IM [#im]

`IM` *extends* [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel) = [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DModel**\<`IM`>(`options?`): `Live2DModel`\<`IM`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4466

Creates a new Live2DModel instance.

#### Parameters [#parameters]

##### options? [#options]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

Options for Live2DModel and Automator.

#### Returns [#returns]

`Live2DModel`\<`IM`>

#### Overrides [#overrides]

`Container.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

`Container.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

`Container.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

`Container.__devtoolLocked`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-3]

`Container._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-4]

`Container._cy`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-5]

`Container._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-6]

`Container._position`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-7]

`Container._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-8]

`Container._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-9]

`Container._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-10]

`Container._sy`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-11]

`Container._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-12]

`Container.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-13]

`Container.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-14]

`Container.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-15]

`Container.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-16]

`Container.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-17]

`Container.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-18]

`Container.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:10

**`Internal`**

#### Inherited from [#inherited-from-19]

`Container.allowChildren`

***

### anchor [#anchor]

\> **anchor**: `ObservablePoint`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4423

The anchor behaves like the one in `PIXI.Sprite`, where `(0, 0)` means the top left
and `(1, 1)` means the bottom right.

***

### anchorMode [#anchormode]

\> `readonly` **anchorMode**: `NonNullable`\<`"canvas"` | `"drawable"` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4411

***

### automator [#automator]

\> **automator**: `Automator`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4459

The Automator instance that controls model automation.

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-7]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-20]

`Container.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-21]

`Container.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-8]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* Container#updateCacheTexture For updating cached content
* [Container#isCachedAsTexture](#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-22]

`Container.cacheAsTexture`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-9]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-23]

`Container.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-10]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-24]

`Container.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-11]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-25]

`Container.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-12]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-26]

`Container.cullArea`

***

### currentGlId [#currentglid]

\> **currentGlId**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4460

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-13]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-27]

`Container.cursor`

***

### deltaTime [#deltatime]

\> **deltaTime**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4454

Elapsed time in milliseconds from last frame to this frame.

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-28]

`Container.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-14]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

Container#destroy For destroying objects

#### Inherited from [#inherited-from-29]

`Container.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-30]

`Container.effects`

***

### elapsedTime [#elapsedtime]

\> **elapsedTime**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4449

Elapsed time in milliseconds since created.

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-15]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-31]

`Container.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-16]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* Container#filters For applying filters
* Rectangle For area definition

#### Inherited from [#inherited-from-32]

`Container.filterArea`

***

### gl [#gl]

\> `protected` **gl**: `WebGL2RenderingContext` | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4444

An ID of Gl context that syncs with `renderer.CONTEXT_UID`. Used to check if the GL context has changed.

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-33]

`Container.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-34]

`Container.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-35]

`Container.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-36]

`Container.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-37]

`Container.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-38]

`Container.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-17]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-39]

`Container.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](#eventmode)

#### Example [#example-18]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-40]

`Container.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-19]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-41]

`Container.interactiveChildren`

***

### internalModel [#internalmodel]

\> **internalModel**: `IM`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4404

The internal model. Though typed as non-nullable, it'll be undefined until the "ready" event is emitted.

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-20]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* Container#cacheAsTexture For enabling caching
* Container#updateCacheTexture For updating cache

#### Inherited from [#inherited-from-42]

`Container.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-21]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-43]

`Container.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-44]

`Container.label`

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-45]

`Container.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-46]

`Container.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-47]

`Container.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-48]

`Container.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-49]

`Container.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-22]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](#worldtransform) For global transform
* [Container#groupTransform](#grouptransform) For render group transform

#### Inherited from [#inherited-from-50]

`Container.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-23]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-51]

`Container.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-52]

`Container.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-53]

`Container.onclick`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-54]

`Container.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-55]

`Container.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-56]

`Container.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-57]

`Container.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-58]

`Container.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-59]

`Container.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-60]

`Container.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-61]

`Container.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-62]

`Container.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-63]

`Container.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-64]

`Container.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-65]

`Container.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-66]

`Container.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-67]

`Container.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-68]

`Container.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-69]

`Container.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-70]

`Container.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-71]

`Container.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-72]

`Container.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-73]

`Container.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-74]

`Container.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-46]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-75]

`Container.onRender`

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-76]

`Container.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-77]

`Container.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-78]

`Container.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-79]

`Container.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-80]

`Container.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-81]

`Container.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-82]

`Container.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-83]

`Container.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-84]

`Container.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-85]

`Container.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-86]

`Container.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-58]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-87]

`Container.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-88]

`Container.parentRenderLayer`

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-89]

`Container.relativeGroupTransform`

***

### renderLive2D [#renderlive2d]

\> **renderLive2D**: (`renderer`) => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4633

Renders the Live2DModel to the renderer.

#### Parameters [#parameters-2]

##### renderer [#renderer]

`Renderer`

The PixiJS Renderer instance.

#### Returns [#returns-4]

`void`

***

### renderPipeId [#renderpipeid]

\> **renderPipeId**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4354

**`Internal`**

#### Overrides [#overrides-1]

`Container.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-59]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-90]

`Container.sortableChildren`

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-5]

`void`

#### Example [#example-60]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](#sortablechildren) For enabling automatic sorting
* [Container#zIndex](#zindex) For setting child order

#### Inherited from [#inherited-from-91]

`Container.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-92]

`Container.sortDirty`

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-61]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-93]

`Container.tabIndex`

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4400

Tag for logging.

***

### textures [#textures]

\> **textures**: `Texture`\<`TextureSource`\<`any`>>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4409

Pixi textures.

***

### transform [#transform]

\> **transform**: [`Live2DTransform`](/pixi-vn-live2d/core/classes/Live2DTransform)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4417

The Live2DTransform instance for this model.

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-94]

`Container.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-6]

`void`

#### Example [#example-62]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-95]

`Container.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-96]

`Container.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-63]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-97]

`Container.zIndex`

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-98]

`Container.prefixed`

## Accessors [#accessors]

### alpha [#alpha]

#### Get Signature [#get-signature]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-64]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* Container#visible For toggling visibility
* Container#renderable For render control

##### Returns [#returns-7]

`number`

#### Set Signature [#set-signature]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value]

`number`

##### Returns [#returns-8]

`void`

#### Inherited from [#inherited-from-99]

`Container.alpha`

***

### angle [#angle]

#### Get Signature [#get-signature-1]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-65]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-9]

`number`

#### Set Signature [#set-signature-1]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-4]

###### value [#value-1]

`number`

##### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-100]

`Container.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-2]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-66]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* Container#alpha For transparency
* Container#tint For color adjustments

##### Returns [#returns-11]

`BLEND_MODES`

#### Set Signature [#set-signature-2]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-5]

###### value [#value-2]

`BLEND_MODES`

##### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-101]

`Container.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-3]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4431

**`Internal`**

##### Returns [#returns-13]

`Bounds`

***

### canBundle [#canbundle]

#### Get Signature [#get-signature-4]

\> **get** **canBundle**(): `false`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4358

**`Internal`**

##### Returns [#returns-14]

`false`

***

### filters [#filters]

#### Get Signature [#get-signature-5]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-67]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-16]

Filter For filter base class

##### Returns [#returns-15]

readonly `Filter`\[]

#### Set Signature [#set-signature-3]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-68]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-17]

Filter For filter base class

##### Parameters [#parameters-6]

###### value [#value-3]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-16]

`void`

#### Inherited from [#inherited-from-102]

`Container.filters`

***

### height [#height]

#### Get Signature [#get-signature-6]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-69]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-17]

`number`

#### Set Signature [#set-signature-4]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-7]

###### value [#value-4]

`number`

##### Returns [#returns-18]

`void`

#### Inherited from [#inherited-from-103]

`Container.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-7]

\> **get** **isRenderable**(): `true`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4356

**`Internal`**

##### Returns [#returns-19]

`true`

#### Overrides [#overrides-2]

`Container.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-8]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-7]

##### Returns [#returns-20]

`boolean`

#### Set Signature [#set-signature-5]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-8]

###### value [#value-5]

`boolean`

##### Returns [#returns-21]

`void`

#### Inherited from [#inherited-from-104]

`Container.isRenderGroup`

***

### origin [#origin]

#### Get Signature [#get-signature-9]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-70]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-22]

`ObservablePoint`

#### Set Signature [#set-signature-6]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-9]

###### value [#value-6]

`number` | `PointData`

##### Returns [#returns-23]

`void`

#### Inherited from [#inherited-from-105]

`Container.origin`

***

### pivot [#pivot]

#### Get Signature [#get-signature-10]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-71]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-24]

`ObservablePoint`

#### Set Signature [#set-signature-7]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-10]

###### value [#value-7]

`number` | `PointData`

##### Returns [#returns-25]

`void`

#### Inherited from [#inherited-from-106]

`Container.pivot`

***

### position [#position]

#### Get Signature [#get-signature-11]

\> **get** **position**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:959

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-72]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-26]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **position**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:960

##### Parameters [#parameters-11]

###### value [#value-8]

`PointData`

##### Returns [#returns-27]

`void`

#### Inherited from [#inherited-from-107]

`Container.position`

***

### renderable [#renderable]

#### Get Signature [#get-signature-12]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-73]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-18]

* Container#visible For skipping transform updates
* Container#alpha For transparency

##### Returns [#returns-28]

`boolean`

#### Set Signature [#set-signature-9]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-12]

###### value [#value-9]

`boolean`

##### Returns [#returns-29]

`void`

#### Inherited from [#inherited-from-108]

`Container.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-13]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-74]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-30]

`number`

#### Set Signature [#set-signature-10]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-13]

###### value [#value-10]

`number`

##### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-109]

`Container.rotation`

***

### scale [#scale]

#### Get Signature [#get-signature-14]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-75]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-4]

4.0.0

##### Returns [#returns-32]

`ObservablePoint`

#### Set Signature [#set-signature-11]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-14]

###### value [#value-11]

`string` | `number` | `PointData`

##### Returns [#returns-33]

`void`

#### Inherited from [#inherited-from-110]

`Container.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-15]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-76]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-5]

4.0.0

##### Default [#default-55]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-34]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-15]

###### value [#value-12]

`PointData`

##### Returns [#returns-35]

`void`

#### Inherited from [#inherited-from-111]

`Container.skew`

***

### tint [#tint]

#### Get Signature [#get-signature-16]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-77]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-56]

```ts
0xFFFFFF
```

##### See [#see-19]

* Container#alpha For transparency
* Container#visible For visibility control

##### Returns [#returns-36]

`number`

#### Set Signature [#set-signature-13]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-16]

###### value [#value-13]

`ColorSource`

##### Returns [#returns-37]

`void`

#### Inherited from [#inherited-from-112]

`Container.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-17]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-78]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-57]

```ts
true
```

##### See [#see-20]

* Container#renderable For render-only control
* Container#alpha For transparency

##### Returns [#returns-38]

`boolean`

#### Set Signature [#set-signature-14]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-17]

###### value [#value-14]

`boolean`

##### Returns [#returns-39]

`void`

#### Inherited from [#inherited-from-113]

`Container.visible`

***

### width [#width]

#### Get Signature [#get-signature-18]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-79]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-40]

`number`

#### Set Signature [#set-signature-15]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-18]

###### value [#value-15]

`number`

##### Returns [#returns-41]

`void`

#### Inherited from [#inherited-from-114]

`Container.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-19]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-80]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-21]

[Container#localTransform](#localtransform) For local space transform

##### Returns [#returns-42]

`Matrix`

#### Inherited from [#inherited-from-115]

`Container.worldTransform`

***

### x [#x]

#### Get Signature [#get-signature-20]

\> **get** **x**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:933

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-81]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-43]

`number`

#### Set Signature [#set-signature-16]

\> **set** **x**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:934

##### Parameters [#parameters-19]

###### value [#value-16]

`number`

##### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-116]

`Container.x`

***

### y [#y]

#### Get Signature [#get-signature-21]

\> **get** **y**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:945

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-82]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-45]

`number`

#### Set Signature [#set-signature-17]

\> **set** **y**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:946

##### Parameters [#parameters-20]

###### value [#value-17]

`number`

##### Returns [#returns-46]

`void`

#### Inherited from [#inherited-from-117]

`Container.y`

## Methods [#methods]

### \_calculateBounds() [#_calculatebounds]

\> `protected` **\_calculateBounds**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4617

Calculates the bounds of the Live2DModel for rendering and interaction purposes.

#### Returns [#returns-47]

`void`

***

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-21]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-48]

`void`

#### Inherited from [#inherited-from-118]

`Container._getGlobalBoundsRecursive`

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-22]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-49]

`U`\[`0`]

The first child that was added

#### Example [#example-83]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-22]

* Container#removeChild For removing children
* Container#addChildAt For adding at specific index

#### Inherited from [#inherited-from-119]

`Container.addChild`

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-23]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-50]

`U`

The child that was added

#### Example [#example-84]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws]

If index is out of bounds

#### See [#see-23]

* Container#addChild For adding to the end
* Container#setChildIndex For moving existing children

#### Inherited from [#inherited-from-120]

`Container.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-24]

###### type [#type]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-51]

`void`

##### Example [#example-85]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-121]

`Container.addEventListener`

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-25]

###### type [#type-1]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-52]

`void`

##### Inherited from [#inherited-from-122]

`Container.addEventListener`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-26]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-53]

`this`

#### Inherited from [#inherited-from-123]

`Container.addListener`

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4470

Insert this model into Pixi's instruction set so zIndex ordering works with other objects.

#### Parameters [#parameters-27]

##### instructionSet [#instructionset]

`InstructionSet`

##### renderer [#renderer-1]

`Renderer`

##### currentLayer [#currentlayer-1]

`RenderLayer`

#### Returns [#returns-54]

`void`

#### Overrides [#overrides-3]

`Container.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:30

**`Internal`**

Collects renderables using a simple method, suitable for containers marked as simple.
This method iterates over the container's children and adds their renderables to the instruction set.

#### Parameters [#parameters-28]

##### instructionSet [#instructionset-1]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-55]

`void`

#### Inherited from [#inherited-from-124]

`Container.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-29]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-3]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-56]

`void`

#### Inherited from [#inherited-from-125]

`Container.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

\> **containsPoint**(`point`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4613

A method required by `PIXI.InteractionManager` to perform hit-testing.

#### Parameters [#parameters-30]

##### point [#point]

`Point`

A Point in local space.

#### Returns [#returns-57]

`boolean`

True if the point is inside this model.

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4646

Destroys the model and all related resources. This takes the same options and also
behaves the same as `PIXI.Container#destroy`.

#### Parameters [#parameters-31]

##### options? [#options-3]

Options parameter. A boolean will act as if all options
have been set to that value

###### baseTexture? [#basetexture]

`boolean`

Only used for child Sprites if `options.children` is set to true
Should it destroy the base texture of the child sprite

###### children? [#children-2]

`boolean`

if set to true, all the children will have their destroy
method called as well. `options` will be passed on to those calls.

###### texture? [#texture]

`boolean`

Only used for child Sprites if `options.children` is set to true
Should it destroy the texture of the child sprite

#### Returns [#returns-58]

`void`

#### Overrides [#overrides-4]

`Container.destroy`

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-59]

`void`

#### Advanced [#advanced-8]

#### Inherited from [#inherited-from-126]

`Container.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-32]

##### e [#e]

`FederatedEvent`

The event to dispatch.

#### Returns [#returns-60]

`boolean`

Whether the FederatedEvent.preventDefault preventDefault() method was not invoked.

#### Example [#example-86]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-127]

`Container.dispatchEvent`

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-33]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-61]

`boolean`

#### Inherited from [#inherited-from-128]

`Container.emit`

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-62]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-129]

`Container.enableRenderGroup`

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-63]

(keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-130]

`Container.eventNames`

***

### expression() [#expression]

\> **expression**(`id?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4576

Shorthand to set an expression.

#### Parameters [#parameters-34]

##### id? [#id]

`string` | `number`

Either the index, or the name of the expression. If not presented, a random expression will be set.

#### Returns [#returns-64]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

***

### focus() [#focus]

\> **focus**(`x`, `y`, `instant?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4584

Updates the focus position. This will not cause the model to immediately look at the position,
instead the movement will be interpolated.

#### Parameters [#parameters-35]

##### x [#x-1]

`number`

Position in world space.

##### y [#y-1]

`number`

Position in world space.

##### instant? [#instant]

`boolean`

Should the focus position be instantly applied.

#### Returns [#returns-65]

`void`

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-36]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-66]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-87]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-24]

* [Container#getLocalBounds](#getlocalbounds) For untransformed bounds
* [Bounds](/pixi-vn-live2d/core/interfaces/Bounds) For bounds properties

#### Inherited from [#inherited-from-131]

`Container.getBounds`

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-37]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-67]

`U`

The child at the given index

#### Example [#example-88]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-25]

* Container#children For direct array access
* Container#getChildByLabel For name-based lookup

#### Inherited from [#inherited-from-132]

`Container.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-38]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-68]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-89]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-26]

* Container#getChildrenByLabel For finding all matches
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-133]

`Container.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-39]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-69]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-27]

Container#getChildByLabel

#### Inherited from [#inherited-from-134]

`Container.getChildByName`

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-40]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-70]

`number`

The index position of the child container

#### Example [#example-90]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-2]

If child is not in this container

#### See [#see-28]

* Container#setChildIndex For changing index
* Container#children For direct array access

#### Inherited from [#inherited-from-135]

`Container.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-41]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-71]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-91]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-29]

* Container#getChildByLabel For finding first match
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-136]

`Container.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-42]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-72]

`Bounds`

The computed bounds.

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-137]

`Container.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-43]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-73]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-92]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-138]

`Container.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-44]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-74]

`Point`

The updated point

#### Example [#example-93]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-30]

* [Container#toGlobal](#toglobal) For converting specific points
* [Container#toLocal](#tolocal) For converting to local space

#### Inherited from [#inherited-from-139]

`Container.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-45]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-75]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-94]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-140]

`Container.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-46]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-76]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-95]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-141]

`Container.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-77]

`Bounds`

The bounding area

#### Example [#example-96]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-31]

* [Container#getBounds](#getbounds) For world space bounds
* [Bounds](/pixi-vn-live2d/core/interfaces/Bounds) For bounds properties

#### Inherited from [#inherited-from-142]

`Container.getLocalBounds`

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-47]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-78]

`Size`

The size of the container.

#### Example [#example-97]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

#### Inherited from [#inherited-from-143]

`Container.getSize`

***

### hitTest() [#hittest]

\> **hitTest**(`x`, `y`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4599

Hit-test on the model.

#### Parameters [#parameters-48]

##### x [#x-2]

`number`

Position in world space.

##### y [#y-2]

`number`

Position in world space.

#### Returns [#returns-79]

`string`\[]

The names of the *hit* hit areas. Can be empty if none is hit.

***

### initializeOnModelLoad() [#initializeonmodelload]

\> `protected` **initializeOnModelLoad**(`_options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4476

A handler of the "modelLoaded" event, invoked when the internal model has been loaded.

#### Parameters [#parameters-49]

##### \_options? [#_options]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

The options used for initialization.

#### Returns [#returns-80]

`void`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-50]

##### event [#event-2]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-81]

`number`

#### Inherited from [#inherited-from-144]

`Container.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-51]

##### event [#event-3]

`T`

#### Returns [#returns-82]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-145]

`Container.listeners`

***

### motion() [#motion]

\> **motion**(`group`, `index?`, `priority?`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4497

Shorthand to start a motion.

#### Parameters [#parameters-52]

##### group [#group]

`string`

The motion group.

##### index? [#index-2]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. (0: No priority, 1: IDLE, 2:NORMAL, 3:FORCE)

##### options? [#options-4]

Additional options for motion.

###### expression? [#expression-1]

`string` | `number`

In case you want to mix up an expression while playing sound (bind with Model.expression()).

###### loop? [#loop]

`boolean`

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.

###### onError? [#onerror]

(`e`) => `void`

Callback function when an error occurs.

###### onFinish? [#onfinish]

() => `void`

Callback function when speaking completes.

###### resetExpression? [#resetexpression]

`boolean`

Reset the expression to default after the motion is finished.

###### sound? [#sound]

`string`

The audio url to file or base64 content.

###### volume? [#volume]

`number`

Volume of the sound (0-1).

#### Returns [#returns-83]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

***

### motionLastFrame() [#motionlastframe]

\> **motionLastFrame**(`group`, `id`, `__namedParameters?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4506

#### Parameters [#parameters-53]

##### group [#group-1]

`string`

##### id [#id-1]

`number`

##### \_\_namedParameters? [#__namedparameters]

###### expression? [#expression-2]

`string` | `number`

#### Returns [#returns-84]

`Promise`\<`boolean`>

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-54]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-85]

`this`

#### Inherited from [#inherited-from-146]

`Container.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-55]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-86]

`this`

#### Inherited from [#inherited-from-147]

`Container.on`

***

### onAnchorChange() [#onanchorchange]

\> `protected` **onAnchorChange**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4481

A callback that observes [anchor](#anchor), invoked when the anchor's values have been changed.

#### Returns [#returns-87]

`void`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-56]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-88]

`this`

#### Inherited from [#inherited-from-148]

`Container.once`

***

### parallelLastFrame() [#parallellastframe]

\> **parallelLastFrame**(`motionList`): `Promise`\<`boolean`\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4541

Shorthand to play the last frame of multiple motions in parallel and await their completion.

This method initiates the final frame of each specified motion concurrently,
leveraging the internal parallel motion manager. Each motion's completion is awaited
sequentially, and the results are returned as an array of success flags.

#### Parameters [#parameters-57]

##### motionList [#motionlist]

`object`\[]

Array of motions to execute.

#### Returns [#returns-89]

`Promise`\<`boolean`\[]>

Resolves with an array where each boolean indicates
whether the corresponding motion completed successfully.

#### Async [#async]

***

### parallelMotion() [#parallelmotion]

\> **parallelMotion**(`motionList`): `Promise`\<`boolean`\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4519

Shorthand to start multiple motions in parallel.

#### Parameters [#parameters-58]

##### motionList [#motionlist-1]

`object`\[]

The motion list, each item includes:
group: The motion group,
index: Index in the motion group,
priority: The priority to be applied. (0: No priority, 1: IDLE, 2:NORMAL, 3:FORCE) (default: 2)
ignoreParamIds: The ids to be ignored,
loop: Whether the motion should loop.

#### Returns [#returns-90]

`Promise`\<`boolean`\[]>

Promise that resolves with a list, indicates the motion is successfully started, with false otherwise.

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-59]

##### event? [#event-7]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-91]

`this`

#### Inherited from [#inherited-from-149]

`Container.removeAllListeners`

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-60]

##### children [#children-3]

...`U`

The Container(s) to remove

#### Returns [#returns-92]

`U`\[`0`]

The first child that was removed

#### Example [#example-98]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-32]

* Container#addChild For adding children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-150]

`Container.removeChild`

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-61]

##### index [#index-3]

`number`

The index to remove the child from

#### Returns [#returns-93]

`U`

The child that was removed

#### Example [#example-99]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-3]

If index is out of bounds

#### See [#see-33]

* Container#removeChild For removing specific children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-151]

`Container.removeChildAt`

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-62]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-94]

`ContainerChild`\[]

List of removed children

#### Example [#example-100]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-4]

If begin/end indexes are invalid

#### See [#see-34]

* Container#addChild For adding children
* Container#removeChild For removing specific children

#### Inherited from [#inherited-from-152]

`Container.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-63]

###### type [#type-2]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-5]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-95]

`void`

##### Inherited from [#inherited-from-153]

`Container.removeEventListener`

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-64]

###### type [#type-3]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-6]

`RemoveListenerOptions`

##### Returns [#returns-96]

`void`

##### Inherited from [#inherited-from-154]

`Container.removeEventListener`

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-97]

`void`

#### Example [#example-101]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-35]

* Container#addChild For adding to a new parent
* Container#removeChild For parent removing children

#### Inherited from [#inherited-from-155]

`Container.removeFromParent`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-65]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-98]

`this`

#### Inherited from [#inherited-from-156]

`Container.removeListener`

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-66]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-99]

`U`\[`0`]

The first child that was reparented

#### Example [#example-102]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-36]

* Container#reparentChildAt For index-specific reparenting
* Container#addChild For simple parenting

#### Inherited from [#inherited-from-157]

`Container.reparentChild`

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-67]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-4]

`number`

The index to reparent the child to

#### Returns [#returns-100]

`U`

The reparented child

#### Example [#example-103]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-5]

If index is out of bounds

#### See [#see-37]

* Container#reparentChild For appending reparented children
* Container#addChildAt For simple indexed parenting

#### Inherited from [#inherited-from-158]

`Container.reparentChildAt`

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-68]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-101]

`void`

#### Inherited from [#inherited-from-159]

`Container.replaceChild`

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-69]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-5]

`number`

The resulting index number for the child

#### Returns [#returns-102]

`void`

#### Example [#example-104]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-6]

If index is out of bounds

#### Throws [#throws-7]

If child is not in container

#### See [#see-38]

* Container#getChildIndex For getting current index
* Container#swapChildren For swapping positions

#### Inherited from [#inherited-from-160]

`Container.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-70]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-103]

`void`

#### Example [#example-105]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-39]

* Container#updateTransform For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-161]

`Container.setFromMatrix`

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-71]

##### options [#options-7]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-104]

`void`

#### Example [#example-106]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-40]

* [Container#mask](#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-162]

`Container.setMask`

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-72]

##### value [#value-18]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-105]

`void`

#### Example [#example-107]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

#### Inherited from [#inherited-from-163]

`Container.setSize`

***

### speak() [#speak]

\> **speak**(`sound`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4560

Shorthand to start speaking a sound with an expression.

#### Parameters [#parameters-73]

##### sound [#sound-1]

`string`

The audio url to file or base64 content.

##### options? [#options-8]

Additional options for speaking.

###### expression? [#expression-3]

`string` | `number`

In case you want to mix up an expression while playing sound (bind with Model.expression()).

###### onError? [#onerror-1]

(`e`) => `void`

Callback function when an error occurs.

###### onFinish? [#onfinish-1]

() => `void`

Callback function when speaking completes.

###### resetExpression? [#resetexpression-1]

`boolean`

Reset the expression to default after the motion is finished.

###### volume? [#volume-1]

`number`

Volume of the sound (0-1).

#### Returns [#returns-106]

`Promise`\<`boolean`>

Promise that resolves with true if the sound is playing, false if it's not.

***

### stopMotions() [#stopmotions]

\> **stopMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4548

Stops all playing motions as well as the sound.

#### Returns [#returns-107]

`void`

***

### stopSpeaking() [#stopspeaking]

\> **stopSpeaking**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4570

Stop current audio playback and lipsync.

#### Returns [#returns-108]

`void`

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-74]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-109]

`void`

#### Example [#example-108]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-8]

If either child is not in container

#### See [#see-41]

* Container#setChildIndex For direct index placement
* Container#getChildIndex For getting current positions

#### Inherited from [#inherited-from-164]

`Container.swapChildren`

***

### tap() [#tap]

\> **tap**(`x`, `y`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4592

Tap on the model. This will perform a hit-testing, and emit a "hit" event
if at least one of the hit areas is hit.

#### Parameters [#parameters-75]

##### x [#x-3]

`number`

Position in world space.

##### y [#y-3]

`number`

Position in world space.

#### Returns [#returns-110]

`void`

#### Emits [#emits-1]

[Live2DModelEvents.hit](/pixi-vn-live2d/core/interfaces/Live2DModelEvents#hit)

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-76]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-111]

`P`

The global position

#### Example [#example-109]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-42]

* [Container#toLocal](#tolocal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-165]

`Container.toGlobal`

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-77]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-112]

`P`

A point object representing the position in local space

#### Example [#example-110]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-43]

* [Container#toGlobal](#toglobal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-166]

`Container.toLocal`

***

### toModelPosition() [#tomodelposition]

\> **toModelPosition**(`position`, `result?`, `skipUpdate?`): `Point`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4607

Calculates the position in the canvas of original, unscaled Live2D model.

#### Parameters [#parameters-78]

##### position [#position-3]

`Point`

A Point in world space.

##### result? [#result]

`Point`

A Point to store the new value. Defaults to a new Point.

##### skipUpdate? [#skipupdate-7]

`boolean`

True to skip the update transform.

#### Returns [#returns-113]

`Point`

The Point in model canvas space.

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4623

Updates the model. Note this method just updates the timer,
and the actual update will be done right before rendering the model.

#### Parameters [#parameters-79]

##### dt [#dt]

`number`

The elapsed time in milliseconds since last frame.

#### Returns [#returns-114]

`void`

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-115]

`void`

#### Inherited from [#inherited-from-167]

`Container.updateLocalTransform`

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-80]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-116]

`this`

This container, for chaining

#### Example [#example-111]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-44]

* Container#setFromMatrix For matrix-based transforms
* [Container#position](#position) For direct position access

#### Inherited from [#inherited-from-168]

`Container.updateTransform`

***

### from() [#from-1]

\> `static` **from**\<`M`>(`this`, `source`, `options?`): `Promise`\<`InstanceType`\<`M`>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4365

Creates a Live2DModel from given source.

#### Type Parameters [#type-parameters-21]

##### M [#m]

`M` *extends* [`Live2DConstructor`](/pixi-vn-live2d/core/type-aliases/Live2DConstructor) = *typeof* `Live2DModel`

#### Parameters [#parameters-81]

##### this [#this]

`M`

##### source [#source]

`string` | `object` | [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Can be one of: settings file URL, settings JSON object, ModelSettings instance.

##### options? [#options-9]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options for the creation.

#### Returns [#returns-117]

`Promise`\<`InstanceType`\<`M`>>

Promise that resolves with the Live2DModel.

***

### fromSync() [#fromsync]

\> `static` **fromSync**\<`M`>(`this`, `source`, `options?`): `InstanceType`\<`M`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4389

Synchronous version of `Live2DModel.from()`. This method immediately returns a Live2DModel instance,
whose resources have not been loaded. Therefore, this model can't be manipulated or rendered
until the "load" event has been emitted.

```js
// no `await` here as it's not a Promise
const model = Live2DModel.fromSync('shizuku.model.json');

// these will cause errors!
// app.stage.addChild(model);
// model.motion('tap_body');

model.once('load', () => {
    // now it's safe
    app.stage.addChild(model);
    model.motion('tap_body');
});
```

#### Type Parameters [#type-parameters-22]

##### M [#m-1]

`M` *extends* [`Live2DConstructor`](/pixi-vn-live2d/core/type-aliases/Live2DConstructor) = *typeof* `Live2DModel`

#### Parameters [#parameters-82]

##### this [#this-1]

`M`

##### source [#source-1]

`string` | `object` | [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Model source, can be a file path, JSON object, or ModelSettings instance.

##### options? [#options-10]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options for the model creation.

#### Returns [#returns-118]

`InstanceType`\<`M`>

The created Live2DModel instance.

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-83]

##### source [#source-2]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-119]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

#### Inherited from [#inherited-from-169]

`Container.mixin`

***

### ~~registerTicker()~~ [#registerticker]

\> `static` **registerTicker**(`tickerClass`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4395

Registers the class of `PIXI.Ticker` for auto updating.

#### Parameters [#parameters-84]

##### tickerClass [#tickerclass]

*typeof* `Ticker`

The Ticker class to be registered.

#### Returns [#returns-120]

`void`

#### Deprecated [#deprecated-4]

Use [Live2DModelOptions.ticker](/pixi-vn-live2d/core/interfaces/AutomatorOptions#ticker) instead.


# Class: Live2DPhysics (/pixi-vn-live2d/core/classes/Live2DPhysics)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5088

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DPhysics**(`coreModel`, `json`): `Live2DPhysics`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5091

#### Parameters [#parameters]

##### coreModel [#coremodel]

`Live2DModelWebGL`

##### json [#json]

[`PhysicsJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PhysicsJSON)

#### Returns [#returns]

`Live2DPhysics`

## Properties [#properties]

### coreModel [#coremodel-1]

\> `readonly` **coreModel**: `Live2DModelWebGL`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5089

***

### physicsHairs [#physicshairs]

\> **physicsHairs**: `PhysicsHair`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5090

## Methods [#methods]

### update() [#update]

\> **update**(`elapsed`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5092

#### Parameters [#parameters-1]

##### elapsed [#elapsed]

`number`

#### Returns [#returns-1]

`void`


# Class: Live2DPose (/pixi-vn-live2d/core/classes/Live2DPose)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5102

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DPose**(`coreModel`, `json`): `Live2DPose`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5106

#### Parameters [#parameters]

##### coreModel [#coremodel]

`Live2DModelWebGL`

##### json [#json]

[`PoseJSON`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PoseJSON)

#### Returns [#returns]

`Live2DPose`

## Properties [#properties]

### coreModel [#coremodel-1]

\> `readonly` **coreModel**: `Live2DModelWebGL`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5103

***

### opacityAnimDuration [#opacityanimduration]

\> **opacityAnimDuration**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5104

***

### partsGroups [#partsgroups]

\> **partsGroups**: `Live2DPartsParam`\[]\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5105

## Methods [#methods]

### copyOpacity() [#copyopacity]

\> **copyOpacity**(`partsGroup`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5109

#### Parameters [#parameters-1]

##### partsGroup [#partsgroup]

`Live2DPartsParam`\[]

#### Returns [#returns-1]

`void`

***

### init() [#init]

\> **init**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5107

#### Returns [#returns-2]

`void`

***

### normalizePartsOpacityGroup() [#normalizepartsopacitygroup]

\> **normalizePartsOpacityGroup**(`partsGroup`, `dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5108

#### Parameters [#parameters-2]

##### partsGroup [#partsgroup-1]

`Live2DPartsParam`\[]

##### dt [#dt]

`number`

#### Returns [#returns-3]

`void`

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5110

#### Parameters [#parameters-3]

##### dt [#dt-1]

`number`

#### Returns [#returns-4]

`void`


# Class: Live2DTransform (/pixi-vn-live2d/core/classes/Live2DTransform)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4284

Useless class. May be useful in the future.

## Extends [#extends]

* `Transform`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2DTransform**(`options?`): `Live2DTransform`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:136

#### Parameters [#parameters]

##### options? [#options]

`TransformOptions`

Options for the transform.

#### Returns [#returns]

`Live2DTransform`

#### Inherited from [#inherited-from]

`Transform.constructor`

## Properties [#properties]

### \_cx [#_cx]

\> `protected` **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:113

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-1]

`Transform._cx`

***

### \_cy [#_cy]

\> `protected` **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:123

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-2]

`Transform._cy`

***

### \_matrix [#_matrix]

\> **\_matrix**: `Matrix`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:55

**`Internal`**

The local transformation matrix.

#### Inherited from [#inherited-from-3]

`Transform._matrix`

***

### \_rotation [#_rotation]

\> `protected` **\_rotation**: `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:108

The rotation amount.

#### Inherited from [#inherited-from-4]

`Transform._rotation`

***

### \_sx [#_sx]

\> `protected` **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:118

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-5]

`Transform._sx`

***

### \_sy [#_sy]

\> `protected` **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:128

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-6]

`Transform._sy`

***

### dirty [#dirty]

\> `protected` **dirty**: `boolean`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:129

#### Inherited from [#inherited-from-7]

`Transform.dirty`

***

### observer [#observer]

\> `protected` **observer**: `Observer`\<`Transform`>

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:130

#### Inherited from [#inherited-from-8]

`Transform.observer`

***

### pivot [#pivot]

\> **pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:94

The pivot point of the container that it rotates around.

#### Example [#example]

```ts
// Center pivot
transform.pivot.set(sprite.width / 2, sprite.height / 2);

// Corner rotation
transform.pivot.set(0, 0);
transform.rotation = Math.PI / 4; // 45 degrees
```

#### Inherited from [#inherited-from-9]

`Transform.pivot`

***

### position [#position]

\> **position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:68

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-1]

```ts
// Basic position setting
transform.position.set(100, 100);

// Individual coordinate access
transform.position.x = 50;
transform.position.y = 75;
```

#### Inherited from [#inherited-from-10]

`Transform.position`

***

### scale [#scale]

\> **scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:81

The scale factor of the object.

#### Example [#example-2]

```ts
// Uniform scaling
transform.scale.set(2, 2);

// Non-uniform scaling
transform.scale.x = 2; // Stretch horizontally
transform.scale.y = 0.5; // Compress vertically
```

#### Inherited from [#inherited-from-11]

`Transform.scale`

***

### skew [#skew]

\> **skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:106

The skew amount, on the x and y axis.

#### Example [#example-3]

```ts
// Apply horizontal skew
transform.skew.x = Math.PI / 6; // 30 degrees

// Apply both skews
transform.skew.set(Math.PI / 6, Math.PI / 8);
```

#### Inherited from [#inherited-from-12]

`Transform.skew`

## Accessors [#accessors]

### matrix [#matrix]

#### Get Signature [#get-signature]

\> **get** **matrix**(): `Matrix`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:150

The transformation matrix computed from the transform's properties.
Combines position, scale, rotation, skew, and pivot into a single matrix.

##### Example [#example-4]

```ts
// Get current matrix
const matrix = transform.matrix;
console.log(matrix.toString());
```

##### See [#see]

* Matrix For matrix operations
* [Transform.setFromMatrix](#setfrommatrix) For setting transform from matrix

##### Returns [#returns-1]

`Matrix`

#### Inherited from [#inherited-from-13]

`Transform.matrix`

***

### rotation [#rotation]

#### Get Signature [#get-signature-1]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:199

The rotation of the object in radians.

##### Example [#example-5]

```ts
// Basic rotation
transform.rotation = Math.PI / 4; // 45 degrees

// Rotate around pivot point
transform.pivot.set(50, 50);
transform.rotation = Math.PI; // 180 degrees around pivot

// Animate rotation
app.ticker.add(() => {
    transform.rotation += 0.1;
});
```

##### See [#see-1]

* [Transform#pivot](#pivot) For rotation point
* [Transform#skew](#skew) For skew effects

##### Returns [#returns-2]

`number`

#### Set Signature [#set-signature]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:200

##### Parameters [#parameters-1]

###### value [#value]

`number`

##### Returns [#returns-3]

`void`

#### Inherited from [#inherited-from-14]

`Transform.rotation`

## Methods [#methods]

### \_onUpdate() [#_onupdate]

\> **\_onUpdate**(`point?`): `void`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:156

**`Internal`**

Called when a value changes.

#### Parameters [#parameters-2]

##### point? [#point]

`ObservablePoint`

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-15]

`Transform._onUpdate`

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:179

Decomposes a matrix and sets the transforms properties based on it.

#### Parameters [#parameters-3]

##### matrix [#matrix-1]

`Matrix`

The matrix to decompose

#### Returns [#returns-5]

`void`

#### Example [#example-6]

```ts
// Basic matrix decomposition
const transform = new Transform();
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

transform.setFromMatrix(matrix);
console.log(transform.position.x); // 100
console.log(transform.rotation); // ~0.785 (π/4)
```

#### See [#see-2]

* Matrix#decompose For the decomposition logic
* [Transform#matrix](#matrix) For getting the current matrix

#### Inherited from [#inherited-from-16]

`Transform.setFromMatrix`

***

### toString() [#tostring]

\> **toString**(): `string`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:159

#### Returns [#returns-6]

`string`

#### Inherited from [#inherited-from-17]

`Transform.toString`

***

### updateSkew() [#updateskew]

\> `protected` **updateSkew**(): `void`

Defined in: node_modules/pixi.js/lib/utils/misc/Transform.d.ts:158

Called when the skew or the rotation changes.

#### Returns [#returns-7]

`void`

#### Inherited from [#inherited-from-18]

`Transform.updateSkew`


# Abstract Class: ModelSettings (/pixi-vn-live2d/core/classes/ModelSettings)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:512

Parses, and provides access to the settings JSON.

## Extended by [#extended-by]

* [`CubismLegacyModelSettings`](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)
* [`CubismModelSettings`](/pixi-vn-live2d/core/classes/CubismModelSettings)

## Constructors [#constructors]

### Constructor [#constructor]

\> `protected` **new ModelSettings**(`json`): `ModelSettings`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:545

#### Parameters [#parameters]

##### json [#json]

`object` & `object`

The settings JSON object.

#### Returns [#returns]

`ModelSettings`

## Properties [#properties]

### json [#json-1]

\> **json**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:513

***

### moc [#moc]

\> `abstract` **moc**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:528

Relative path of he moc file, typically ends with `.moc` in Cubism 2 and `.moc3` in Cubism 4.

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:519

The model's name, typically used for displaying or logging. By default it's inferred from
the URL by taking the folder name (the second to last component). In Cubism 2 it'll be overwritten
by the `name` field of settings JSON.

***

### physics? [#physics]

\> `optional` **physics?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:540

Relative path of the physics file.

***

### pose? [#pose]

\> `optional` **pose?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:536

Relative path of the pose file.

***

### textures [#textures]

\> `abstract` **textures**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:532

Relative paths of the texture images.

***

### url [#url]

\> **url**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:524

URL of the model settings file, used to resolve paths of the resource files defined in settings.
This typically ends with `.model.json` in Cubism 2 and `.model3.json` in Cubism 4.

## Methods [#methods]

### getDefinedFiles() [#getdefinedfiles]

\> **getDefinedFiles**(): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:594

Retrieves all resource files defined in the settings.

#### Returns [#returns-1]

`string`\[]

A flat array of the paths of all resource files.

```js
modelSettings.getDefinedFiles();
// returns: ["foo.moc", "foo.png", ...]
```

***

### getFileStem() [#getfilestem]

\> `protected` **getFileStem**(`path?`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:560

Returns the file name without extension from a path.

#### Parameters [#parameters-1]

##### path? [#path]

`string`

#### Returns [#returns-2]

`string` | `undefined`

***

### normalizeName() [#normalizename]

\> `protected` **normalizeName**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:551

Ensures the model name is meaningful; falls back to the folder name when missing or placeholder.

#### Returns [#returns-3]

`void`

***

### replaceFiles() [#replacefiles]

\> **replaceFiles**(`replacer`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:584

Replaces the resource files by running each file through the `replacer`.

#### Parameters [#parameters-2]

##### replacer [#replacer]

(`file`, `path`) => `string`

Invoked with two arguments: `(file, path)`, where `file` is the file definition,
and `path` is its property path in the ModelSettings instance. A string must be returned to be the replacement.

```js
modelSettings.replaceFiles((file, path) => {
    // file = "foo.moc", path = "moc"
    // file = "foo.png", path = "textures[0]"
    // file = "foo.mtn", path = "motions.idle[0].file"
    // file = "foo.motion3.json", path = "motions.idle[0].File"

    return "bar/" + file;
});
```

#### Returns [#returns-4]

`void`

***

### resolveURL() [#resolveurl]

\> **resolveURL**(`path`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:567

Resolves a relative path using the [url](#url). This is used to resolve the resource files
defined in the settings.

#### Parameters [#parameters-3]

##### path [#path-1]

`string`

Relative path.

#### Returns [#returns-5]

`string`

Resolved path.

***

### setModelName() [#setmodelname]

\> `protected` **setModelName**(...`candidates`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:556

Picks the first non-empty, non-placeholder name from candidates and applies it.
Falls back to [normalizeName](#normalizename) when no candidate is usable.

#### Parameters [#parameters-4]

##### candidates [#candidates]

...(`string` | `undefined`)\[]

#### Returns [#returns-6]

`void`

***

### validateFiles() [#validatefiles]

\> **validateFiles**(`files`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:603

Validates that the files defined in the settings exist in given files. Each file will be
resolved by [resolveURL](/pixi-vn-live2d/core/functions/resolveURL) before comparison.

#### Parameters [#parameters-5]

##### files [#files]

`string`\[]

A flat array of file paths.

#### Returns [#returns-7]

`string`\[]

All the files which are defined in the settings and also exist in given files,
*including the optional files*.

#### Throws [#throws]

Error if any *essential* file is defined in settings but not included in given files.


# Abstract Class: MotionManager<Motion, MotionSpec> (/pixi-vn-live2d/core/classes/MotionManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3373

Handles the motion playback for Live2D models.
Responsible for loading, playing, and managing motion states and audio.

## Emits [#emits]

[MotionManagerEvents](/pixi-vn-live2d/core/interfaces/MotionManagerEvents)

## Extends [#extends]

* `EventEmitter`

## Extended by [#extended-by]

* [`CubismLegacyMotionManager`](/pixi-vn-live2d/core/classes/CubismLegacyMotionManager)
* [`CubismMotionManager`](/pixi-vn-live2d/core/classes/CubismMotionManager)

## Type Parameters [#type-parameters]

### Motion [#motion]

`Motion` = `unknown`

### MotionSpec [#motionspec]

`MotionSpec` = `unknown`

## Constructors [#constructors]

### Constructor [#constructor]

\> `protected` **new MotionManager**\<`Motion`, `MotionSpec`>(`parent`): `MotionManager`\<`Motion`, `MotionSpec`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3459

Constructor for MotionManager.

#### Parameters [#parameters]

##### parent [#parent]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

The parent InternalModel.

#### Returns [#returns]

`MotionManager`\<`Motion`, `MotionSpec`>

#### Overrides [#overrides]

`EventEmitter.constructor`

## Properties [#properties]

### currentAnalyzer? [#currentanalyzer]

\> `optional` **currentAnalyzer?**: `AnalyserNode`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3434

Analyzer element for the current sound being played.

***

### currentAudio? [#currentaudio]

\> `optional` **currentAudio?**: `Sound`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3429

Audio element of the current motion if a sound file is defined with it.

***

### currentContext? [#currentcontext]

\> `optional` **currentContext?**: `AudioContext`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3439

Context element for the current sound being played.

***

### definitions [#definitions]

\> `abstract` `readonly` **definitions**: `Partial`\<`Record`\<`string`, `MotionSpec`\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3384

Motion definitions copied from ModelSettings.

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3449

Flags whether the instance has been destroyed.

***

### expressionManager? [#expressionmanager]

\> `abstract` `optional` **expressionManager?**: [`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)\<`unknown`, `unknown`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3406

Expression manager for handling model expressions.
Can be undefined if the settings define no expression.

***

### groups [#groups]

\> `abstract` `readonly` **groups**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3390

Motion groups with specific internal usages. Includes at least the 'idle' field.

#### idle [#idle]

\> **idle**: `string`

***

### motionDataType [#motiondatatype]

\> `abstract` `readonly` **motionDataType**: `"json"` | `"arraybuffer"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3399

Indicates the content type of the motion files, varies in different Cubism versions.
Used as `xhr.responseType`.

***

### motionGroups [#motiongroups]

\> **motionGroups**: `Partial`\<`Record`\<`string`, (`Motion` | `undefined` | `null`)\[]>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3419

The Motions. The structure is the same as [definitions](#definitions), initially each group contains
an empty array, which means all motions will be `undefined`. When a Motion has been loaded,
it'll fill the place in which it should be; when it fails to load, the place will be filled
with `null`.

***

### parent [#parent-1]

\> **parent**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3454

Reference to the parent InternalModel.

***

### playing [#playing]

\> **playing**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3444

Flags whether there is a motion currently playing.

***

### settings [#settings]

\> `readonly` **settings**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3411

The ModelSettings reference.

***

### state [#state]

\> **state**: [`MotionState`](/pixi-vn-live2d/core/classes/MotionState)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3424

Maintains the state of this MotionManager.

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3378

Tag for logging.

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from]

`EventEmitter.prefixed`

## Methods [#methods]

### \_startMotion() [#_startmotion]

\> `abstract` `protected` **\_startMotion**(`motion`, `onFinish?`, `ignoreParamIds?`, `loop?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3613

Starts the Motion.

#### Parameters [#parameters-1]

##### motion [#motion-1]

`Motion`

The Motion to start.

##### onFinish? [#onfinish]

(`motion`) => `void`

Optional callback when finished.

##### ignoreParamIds? [#ignoreparamids]

`string`\[]

The ids to be ignored.

##### loop? [#loop]

`boolean`

Whether the motion should loop.

#### Returns [#returns-1]

`number`

An ID or token for the motion.

***

### \_stopAllMotions() [#_stopallmotions]

\> `abstract` `protected` **\_stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3619

Stops all playing motions.

#### Returns [#returns-2]

`void`

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-1]

##### T [#t]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-2]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-3]

`this`

#### Inherited from [#inherited-from-1]

`EventEmitter.addListener`

***

### createMotion() [#createmotion]

\> `abstract` **createMotion**(`data`, `group`, `definition`): `Motion`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3579

Creates a Motion from the data.

#### Parameters [#parameters-3]

##### data [#data]

`object` | `ArrayBuffer`

Content of the motion file. The format must be consistent with [MotionManager#motionDataType](#motiondatatype).

##### group [#group]

`string`

The motion group.

##### definition [#definition]

`MotionSpec`

The motion definition.

#### Returns [#returns-4]

`Motion`

The created Motion.

***

### destroy() [#destroy]

\> **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3565

Destroys the instance and releases all resources.

#### Returns [#returns-5]

`void`

#### Emits [#emits-1]

[MotionManagerEvents.destroy](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#destroy)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-2]

##### T [#t-1]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-4]

##### event [#event-1]

`T`

##### args [#args]

...`any`\[]

#### Returns [#returns-6]

`boolean`

#### Inherited from [#inherited-from-2]

`EventEmitter.emit`

***

### eventNames() [#eventnames]

\> **eventNames**(): (`string` | `symbol`)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-7]

(`string` | `symbol`)\[]

#### Inherited from [#inherited-from-3]

`EventEmitter.eventNames`

***

### getMotionAndApplyExpression() [#getmotionandapplyexpression]

\> `protected` **getMotionAndApplyExpression**(`group`, `index`, `expression?`): `Promise`\<`unknown`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3637

Loads a motion and applies the given expression with FORCE priority.

#### Parameters [#parameters-5]

##### group [#group-1]

`string`

The motion group.

##### index [#index]

`number`

The motion index.

##### expression? [#expression]

`string` | `number`

Expression to apply (optional).

#### Returns [#returns-8]

`Promise`\<`unknown`>

The loaded motion, or null if not started.

***

### getMotionFile() [#getmotionfile]

\> `abstract` **getMotionFile**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3586

Retrieves the motion's file path by its definition.

#### Parameters [#parameters-6]

##### definition [#definition-1]

`MotionSpec`

Motion definition.

#### Returns [#returns-9]

`string`

The file path extracted from the given definition. Not resolved.

***

### getMotionName() [#getmotionname]

\> `abstract` `protected` **getMotionName**(`definition`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3594

Retrieves the motion's name by its definition.

#### Parameters [#parameters-7]

##### definition [#definition-2]

`MotionSpec`

Motion definition.

#### Returns [#returns-10]

`string`

The motion's name.

***

### getSoundFile() [#getsoundfile]

\> `abstract` `protected` **getSoundFile**(`definition`): `string` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3602

Retrieves the motion's sound file by its definition.

#### Parameters [#parameters-8]

##### definition [#definition-3]

`MotionSpec`

Motion definition.

#### Returns [#returns-11]

`string` | `undefined`

The motion's sound file, or undefined.

***

### init() [#init]

\> `protected` **init**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3464

Should be called in the constructor of derived class to initialize options and setup motions.

#### Parameters [#parameters-9]

##### options? [#options]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Initialization options for the manager.

#### Returns [#returns-12]

`void`

***

### initializeAudio() [#initializeaudio]

\> `protected` **initializeAudio**(`audio`, `volume`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3490

Initializes audio playback and sets up audio analysis for lipsync.

#### Parameters [#parameters-10]

##### audio [#audio]

`Sound`

The Sound to initialize.

##### volume [#volume]

`number`

The playback volume (0-1).

#### Returns [#returns-13]

`void`

***

### isFinished() [#isfinished]

\> `abstract` **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3570

Checks if the motion playback has finished.

#### Returns [#returns-14]

`boolean`

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-11]

##### event [#event-2]

`string` | `symbol`

#### Returns [#returns-15]

`number`

#### Inherited from [#inherited-from-4]

`EventEmitter.listenerCount`

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-3]

##### T [#t-2]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-12]

##### event [#event-3]

`T`

#### Returns [#returns-16]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-5]

`EventEmitter.listeners`

***

### loadMotion() [#loadmotion]

\> **loadMotion**(`group`, `index`): `Promise`\<`Motion` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3479

Loads a Motion in a motion group. Errors in this method will not be thrown,
but be emitted with a "motionLoadError" event.

#### Parameters [#parameters-13]

##### group [#group-2]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

#### Returns [#returns-17]

`Promise`\<`Motion` | `undefined`>

Promise that resolves with the Motion, or with undefined if it can't be loaded.

#### Emits [#emits-2]

[MotionManagerEvents.motionLoaded](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaded)

#### Emits [#emits-3]

[MotionManagerEvents.motionLoadError](/pixi-vn-live2d/core/interfaces/MotionManagerEvents#motionloaderror)

***

### motionLastFrame() [#motionlastframe]

\> `abstract` **motionLastFrame**(`group`, `index`, `expression`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3646

Play the last frame of the given motion, optionally applying an expression.

#### Parameters [#parameters-14]

##### group [#group-3]

`string`

Motion group.

##### index [#index-2]

`number`

Motion index.

##### expression [#expression-1]

Expression to apply (optional).

###### expression? [#expression-2]

`string` | `number`

#### Returns [#returns-18]

`Promise`\<`boolean`>

Promise resolving to true if successful.

***

### mouthSync() [#mouthsync]

\> **mouthSync**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3560

Move the mouth for lipsync.

#### Returns [#returns-19]

`number`

The current lipsync value.

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-4]

##### T [#t-3]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-15]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-20]

`this`

#### Inherited from [#inherited-from-6]

`EventEmitter.off`

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-4]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-16]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-21]

`this`

#### Inherited from [#inherited-from-7]

`EventEmitter.on`

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-5]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-17]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-22]

`this`

#### Inherited from [#inherited-from-8]

`EventEmitter.once`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-18]

##### event? [#event-7]

`string` | `symbol`

#### Returns [#returns-23]

`this`

#### Inherited from [#inherited-from-9]

`EventEmitter.removeAllListeners`

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-6]

`T` *extends* `string` | `symbol`

#### Parameters [#parameters-19]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-24]

`this`

#### Inherited from [#inherited-from-10]

`EventEmitter.removeListener`

***

### setupMotions() [#setupmotions]

\> `protected` **setupMotions**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3469

Sets up motions from the definitions, and preloads them according to the preload strategy.

#### Parameters [#parameters-20]

##### options? [#options-1]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

Options controlling which motions to preload.

#### Returns [#returns-25]

`void`

***

### speak() [#speak]

\> **speak**(`sound`, `volume?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3502

Only play sound with lip sync.

#### Parameters [#parameters-21]

##### sound [#sound]

`string`

The audio url or base64 content.

##### volume? [#volume-1]

Volume of the sound (0-1).

###### expression? [#expression-3]

`string` | `number`

###### onError? [#onerror]

(`e`) => `void`

###### onFinish? [#onfinish-1]

() => `void`

###### resetExpression? [#resetexpression]

`boolean`

###### volume? [#volume-2]

`number`

#### Returns [#returns-26]

`Promise`\<`boolean`>

Promise that resolves with true if the sound is playing, false otherwise.

***

### startMotion() [#startmotion]

\> **startMotion**(`group`, `index`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3525

Starts a motion with the given priority.

#### Parameters [#parameters-22]

##### group [#group-4]

`string`

The motion group.

##### index [#index-3]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: NORMAL (2).

##### sound? [#sound-1]

[`MotionStartOptions`](/pixi-vn-live2d/core/interfaces/MotionStartOptions)

The audio url or base64 content.

#### Returns [#returns-27]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

***

### startRandomMotion() [#startrandommotion]

\> **startRandomMotion**(`group`, `priority?`, `sound?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3540

Starts a random Motion as given priority.

#### Parameters [#parameters-23]

##### group [#group-5]

`string`

The motion group.

##### priority? [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. Default: IDLE (1).

##### sound? [#sound-2]

[`MotionStartRandomOptions`](/pixi-vn-live2d/core/type-aliases/MotionStartRandomOptions)

The audio url or base64 content.

#### Returns [#returns-28]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, false otherwise.

***

### stopAllMotions() [#stopallmotions]

\> **stopAllMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3548

Stops all playing motions as well as the sound.

#### Returns [#returns-29]

`void`

***

### stopSpeaking() [#stopspeaking]

\> **stopSpeaking**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3544

Stops current audio playback and lipsync.

#### Returns [#returns-30]

`void`

***

### update() [#update]

\> **update**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3555

Updates parameters of the core model.

#### Parameters [#parameters-24]

##### model [#model]

`object`

The core model.

##### now [#now]

`number`

Current time in milliseconds.

#### Returns [#returns-31]

`boolean`

True if the parameters have been actually updated.

***

### updateParameters() [#updateparameters]

\> `abstract` `protected` **updateParameters**(`model`, `now`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3628

Updates parameters of the core model.

#### Parameters [#parameters-25]

##### model [#model-1]

`object`

The core model.

##### now [#now-1]

`number`

Current time in milliseconds.

#### Returns [#returns-32]

`boolean`

True if the parameters have been actually updated.


# Class: MotionState (/pixi-vn-live2d/core/classes/MotionState)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:621

Handles the state of a MotionManager.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new MotionState**(): `MotionState`

#### Returns [#returns]

`MotionState`

## Properties [#properties]

### currentGroup? [#currentgroup]

\> `optional` **currentGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:642

Group of current motion.

***

### currentIndex? [#currentindex]

\> `optional` **currentIndex?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:646

Index of current motion in its group.

***

### currentPriority [#currentpriority]

\> **currentPriority**: [`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:633

Priority of the current motion. Will be `MotionPriority.NONE` if there's no playing motion.

***

### debug [#debug]

\> **debug**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:629

When enabled, the states will be dumped to the logger when an exception occurs.

***

### reservedGroup? [#reservedgroup]

\> `optional` **reservedGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:650

Group of the reserved motion.

***

### reservedIdleGroup? [#reservedidlegroup]

\> `optional` **reservedIdleGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:658

Group of the reserved idle motion.

***

### reservedIdleIndex? [#reservedidleindex]

\> `optional` **reservedIdleIndex?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:662

Index of the reserved idle motion in its group.

***

### reservedIndex? [#reservedindex]

\> `optional` **reservedIndex?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:654

Index of the reserved motion in its group.

***

### reservePriority [#reservepriority]

\> **reservePriority**: [`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:638

Priority of the reserved motion, which is still in loading and will be played once loaded.
Will be `MotionPriority.NONE` if there's no reserved motion.

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:625

Tag for logging.

## Methods [#methods]

### complete() [#complete]

\> **complete**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:683

Notifies the motion playback has finished.

#### Returns [#returns-1]

`void`

***

### dump() [#dump]

\> **dump**(`requestedGroup?`, `requestedIndex?`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:716

Dumps the state for debugging.

#### Parameters [#parameters]

##### requestedGroup? [#requestedgroup]

`string`

##### requestedIndex? [#requestedindex]

`number`

#### Returns [#returns-2]

`string`

***

### isActive() [#isactive]

\> **isActive**(`group`, `index`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:700

Checks if a Motion is currently playing or has reserved.

#### Parameters [#parameters-1]

##### group [#group]

`string`

##### index [#index]

`number`

#### Returns [#returns-3]

`boolean`

True if active.

***

### reserve() [#reserve]

\> **reserve**(`group`, `index`, `priority`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:670

Reserves the playback for a motion.

#### Parameters [#parameters-2]

##### group [#group-1]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

##### priority [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied.

#### Returns [#returns-4]

`boolean`

True if the reserving has succeeded.

***

### reset() [#reset]

\> **reset**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:704

Resets the state.

#### Returns [#returns-5]

`void`

***

### setCurrent() [#setcurrent]

\> **setCurrent**(`group`, `index`, `priority`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:687

Sets the current motion.

#### Parameters [#parameters-3]

##### group [#group-2]

`string` | `undefined`

##### index [#index-2]

`number` | `undefined`

##### priority [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

#### Returns [#returns-6]

`void`

***

### setReserved() [#setreserved]

\> **setReserved**(`group`, `index`, `priority`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:691

Sets the reserved motion.

#### Parameters [#parameters-4]

##### group [#group-3]

`string` | `undefined`

##### index [#index-3]

`number` | `undefined`

##### priority [#priority-2]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

#### Returns [#returns-7]

`void`

***

### setReservedIdle() [#setreservedidle]

\> **setReservedIdle**(`group`, `index`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:695

Sets the reserved idle motion.

#### Parameters [#parameters-5]

##### group [#group-4]

`string` | `undefined`

##### index [#index-4]

`number` | `undefined`

#### Returns [#returns-8]

`void`

***

### shouldOverrideExpression() [#shouldoverrideexpression]

\> **shouldOverrideExpression**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:712

Checks if the model's expression should be overridden by the motion.

#### Returns [#returns-9]

`boolean`

***

### shouldRequestIdleMotion() [#shouldrequestidlemotion]

\> **shouldRequestIdleMotion**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:708

Checks if an idle motion should be requests to play.

#### Returns [#returns-10]

`boolean`

***

### start() [#start]

\> **start**(`motion`, `group`, `index`, `priority`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:679

Requests the playback for a motion.

#### Parameters [#parameters-6]

##### motion [#motion]

`unknown`

The Motion, can be undefined.

##### group [#group-5]

`string`

The motion group.

##### index [#index-5]

`number`

Index in the motion group.

##### priority [#priority-3]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied.

#### Returns [#returns-11]

`boolean`

True if the request has been approved, i.e. the motion is allowed to play.


# Class: SoundManager (/pixi-vn-live2d/core/classes/SoundManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3912

Manages all the sounds.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new SoundManager**(): `SoundManager`

#### Returns [#returns]

`SoundManager`

## Properties [#properties]

### \_volume [#_volume]

\> `protected` `static` **\_volume**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3923

***

### aliases [#aliases]

\> `protected` `static` **aliases**: `WeakMap`\<`Sound`, \{ `alias`: `string`; `library`: `SoundLibrary`; }>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3919

***

### analysers [#analysers]

\> `static` **analysers**: `AnalyserNode`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3917

***

### audios [#audios]

\> `static` **audios**: `Sound`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3916

Audio elements playing or pending to play. Finished audios will be removed automatically.

***

### contexts [#contexts]

\> `static` **contexts**: `AudioContext`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3918

## Accessors [#accessors]

### volume [#volume]

#### Get Signature [#get-signature]

\> **get** `static` **volume**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3927

Global volume that applies to all the sounds.

##### Returns [#returns-1]

`number`

#### Set Signature [#set-signature]

\> **set** `static` **volume**(`value`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3928

##### Parameters [#parameters]

###### value [#value]

`number`

##### Returns [#returns-2]

`void`

## Methods [#methods]

### add() [#add]

\> `static` **add**(`file`, `onError?`): `Promise`\<`Sound` | `null`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3935

Creates an audio element and adds it to the [audios](#audios).

#### Parameters [#parameters-1]

##### file [#file]

`string`

URL of the sound file.

##### onError? [#onerror]

(`e`) => `void`

Callback invoked when error occurs.

#### Returns [#returns-3]

`Promise`\<`Sound` | `null`>

Created audio element.

***

### addAnalyzer() [#addanalyzer]

\> `static` **addAnalyzer**(`audio`, `context`): `AnalyserNode` | `undefined`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3942

#### Parameters [#parameters-2]

##### audio [#audio]

`Sound`

##### context [#context]

`AudioContext`

#### Returns [#returns-4]

`AnalyserNode` | `undefined`

***

### analyze() [#analyze]

\> `static` **analyze**(`analyser?`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3948

Get volume for lip sync

#### Parameters [#parameters-3]

##### analyser? [#analyser]

`AnalyserNode`

An analyzer element.

#### Returns [#returns-5]

`number`

Returns value to feed into lip sync

***

### destroy() [#destroy]

\> `static` **destroy**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3957

Destroys all managed audios.

#### Returns [#returns-6]

`void`

***

### dispose() [#dispose]

\> `static` **dispose**(`audio`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3953

Disposes an audio element and removes it from [audios](#audios).

#### Parameters [#parameters-4]

##### audio [#audio-1]

`Sound`

An audio element.

#### Returns [#returns-7]

`void`

***

### play() [#play]

\> `static` **play**(`audio`, `onFinish?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3941

Plays the sound.

#### Parameters [#parameters-5]

##### audio [#audio-2]

`Sound`

An audio element.

##### onFinish? [#onfinish]

() => `void`

Callback invoked when the playback has finished.

#### Returns [#returns-8]

`void`


# Class: XHRLoader (/pixi-vn-live2d/core/classes/XHRLoader)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4736

The basic XHR loader.

A network error will be thrown with the following properties:

* `url` - The request URL.
* `status` - The HTTP status.
* `aborted` - True if the error is caused by aborting the XHR.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new XHRLoader**(): `XHRLoader`

#### Returns [#returns]

`XHRLoader`

## Properties [#properties]

### allXhrSet [#allxhrset]

\> `static` **allXhrSet**: `Set`\<`XMLHttpRequest`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4744

All the created XHRs as a flat array.

***

### loader [#loader]

\> `static` **loader**: [`Middleware`](/pixi-vn-live2d/core/type-aliases/Middleware)\<[`Live2DLoaderContext`](/pixi-vn-live2d/core/interfaces/Live2DLoaderContext)>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4748

Middleware for Live2DLoader.

***

### xhrMap [#xhrmap]

\> `static` **xhrMap**: `WeakMap`\<[`Live2DLoaderTarget`](/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget), `Set`\<`XMLHttpRequest`>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4740

All the created XHRs, keyed by their owners respectively.

## Methods [#methods]

### cancelXHRs() [#cancelxhrs]

\> `static` **cancelXHRs**(`this`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4761

Cancels all XHRs related to this target.

#### Parameters [#parameters]

##### this [#this]

[`Live2DLoaderTarget`](/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget)

#### Returns [#returns-1]

`void`

***

### createXHR() [#createxhr]

\> `static` **createXHR**\<`T`>(`target`, `url`, `type`, `onload`, `onerror`): `XMLHttpRequest`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4757

Creates a managed XHR.

#### Type Parameters [#type-parameters]

##### T [#t]

`T` = `unknown`

#### Parameters [#parameters-1]

##### target [#target]

[`Live2DLoaderTarget`](/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget) | `undefined`

If provided, the XHR will be canceled when receiving an "destroy" event from the target.

##### url [#url]

`string`

The URL.

##### type [#type]

`XMLHttpRequestResponseType`

The XHR response type.

##### onload [#onload]

(`data`) => `void`

Load listener.

##### onerror [#onerror]

(`e`) => `void`

Error handler.

#### Returns [#returns-2]

`XMLHttpRequest`

***

### release() [#release]

\> `static` **release**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4765

Release all XHRs.

#### Returns [#returns-3]

`void`


# Enumeration: EyeState (/pixi-vn-live2d/core/enumerations/EyeState)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5066

## Enumeration Members [#enumeration-members]

### Closed [#closed]

\> **Closed**: `2`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5069

***

### Closing [#closing]

\> **Closing**: `1`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5068

***

### Idle [#idle]

\> **Idle**: `0`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5067

***

### Opening [#opening]

\> **Opening**: `3`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5070


# Enumeration: MotionPreloadStrategy (/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3360

Indicates how the motions will be preloaded.

## Enumeration Members [#enumeration-members]

### ALL [#all]

\> **ALL**: `"ALL"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3362

Preload all the motions.

***

### IDLE [#idle]

\> **IDLE**: `"IDLE"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3364

Preload only the idle motions.

***

### NONE [#none]

\> **NONE**: `"NONE"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3366

No preload.


# Enumeration: MotionPriority (/pixi-vn-live2d/core/enumerations/MotionPriority)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:608

Indicates the motion priority.

## Enumeration Members [#enumeration-members]

### FORCE [#force]

\> **FORCE**: `3`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:616

High priority. Motions as this priority will always be played regardless of the current priority.

***

### IDLE [#idle]

\> **IDLE**: `1`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:612

Low priority, used when starting idle motions automatically.

***

### NONE [#none]

\> **NONE**: `0`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:610

States that the model is currently not playing any motion. This priority cannot be applied to a motion.

***

### NORMAL [#normal]

\> **NORMAL**: `2`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:614

Medium priority.


# Function: MBToByte() (/pixi-vn-live2d/core/functions/MBToByte)



\> **MBToByte**(`value`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4839

## Parameters [#parameters]

### value [#value]

`number`

## Returns [#returns]

`number`


# Function: applyMixins() (/pixi-vn-live2d/core/functions/applyMixins)



\> **applyMixins**(`derivedCtor`, `baseCtors`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4861

## Parameters [#parameters]

### derivedCtor [#derivedctor]

(...`args`) => `any`

### baseCtors [#basectors]

(...`args`) => `any`\[]

## Returns [#returns]

`void`

## See [#see]

[https://www.typescriptlang.org/docs/handbook/mixins.html](https://www.typescriptlang.org/docs/handbook/mixins.html)


# Function: clamp() (/pixi-vn-live2d/core/functions/clamp)



\> **clamp**(`num`, `lower`, `upper`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4837

## Parameters [#parameters]

### num [#num]

`number`

### lower [#lower]

`number`

### upper [#upper]

`number`

## Returns [#returns]

`number`


# Function: configureCubismSDK() (/pixi-vn-live2d/core/functions/configureCubismSDK)



\> **configureCubismSDK**(`config?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6976

Configures global Cubism startup settings.

## Parameters [#parameters]

### config? [#config]

[`CubismConfig`](/pixi-vn-live2d/core/interfaces/CubismConfig)

## Returns [#returns]

`void`


# Function: copyArray() (/pixi-vn-live2d/core/functions/copyArray)



\> **copyArray**\<`FromKey`, `From`, `ToKey`, `To`>(`type`, `from`, `to`, `fromKey`, `toKey`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4857

Copies an array at `key`, filtering the items that match the `type`.

## Type Parameters [#type-parameters]

### FromKey [#fromkey]

`FromKey` *extends* `string` | `number` | `symbol`

### From [#from]

`From` *extends* `Partial`\<`Record`\<`FromKey`, `any`\[]>>

### ToKey [#tokey]

`ToKey` *extends* `string` | `number` | `symbol`

### To [#to]

`To` *extends* `Partial`\<`Record`\<`ToKey`, `any`\[]>>

## Parameters [#parameters]

### type [#type]

`string`

Type expected to match `typeof` on the items.

### from [#from-1]

`From`

Source object.

### to [#to-1]

`To`

Destination object.

### fromKey [#fromkey-1]

`FromKey`

Key of the array property in source object.

### toKey [#tokey-1]

`ToKey`

Key of the array property in destination object.

## Returns [#returns]

`void`


# Function: copyProperty() (/pixi-vn-live2d/core/functions/copyProperty)



\> **copyProperty**\<`From`, `FromKey`, `ToKey`, `To`>(`type`, `from`, `to`, `fromKey`, `toKey`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4848

Copies a property at only if it matches the `type`.

## Type Parameters [#type-parameters]

### From [#from]

`From`

### FromKey [#fromkey]

`FromKey` *extends* `string` | `number` | `symbol`

### ToKey [#tokey]

`ToKey` *extends* `string` | `number` | `symbol`

### To [#to]

`To` *extends* `Partial`\<`Record`\<`ToKey`, `From`\[`FromKey`]>>

## Parameters [#parameters]

### type [#type]

`string`

Type expected to match `typeof` on the property.

### from [#from-1]

`From`

Source object.

### to [#to-1]

`To`

Destination object.

### fromKey [#fromkey-1]

`FromKey`

Key of the property in source object.

### toKey [#tokey-1]

`ToKey`

Key of the property in destination object.

## Returns [#returns]

`void`


# Function: cubismReady() (/pixi-vn-live2d/core/functions/cubismReady)



\> **cubismReady**(): `Promise`\<`void`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6981

Promises that the Cubism framework is ready to work.

## Returns [#returns]

`Promise`\<`void`>

Promise that resolves if the startup has succeeded, rejects if failed.


# Function: folderName() (/pixi-vn-live2d/core/functions/folderName)



\> **folderName**(`url`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4867

Gets the name of parent folder in a url.

## Parameters [#parameters]

### url [#url]

`string`

URL of a file.

## Returns [#returns]

`string`

Name of the parent folder, or the file itself if it has no parent folder.


# Function: normalizeHitAreaDefs() (/pixi-vn-live2d/core/functions/normalizeHitAreaDefs)



\> **normalizeHitAreaDefs**(`raw`, `resolveIndex`): [`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3106

## Parameters [#parameters]

### raw [#raw]

`unknown`

### resolveIndex [#resolveindex]

(`id`) => `number`

## Returns [#returns]

[`CommonHitArea`](/pixi-vn-live2d/core/interfaces/CommonHitArea)\[]


# Function: rand() (/pixi-vn-live2d/core/functions/rand)



\> **rand**(`min`, `max`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4838

## Parameters [#parameters]

### min [#min]

`number`

### max [#max]

`number`

## Returns [#returns]

`number`


# Function: reconfigureCubismSDK() (/pixi-vn-live2d/core/functions/reconfigureCubismSDK)



\> **reconfigureCubismSDK**(`config?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6989

Reconfigures Cubism settings and restarts the framework so they take effect.

## Parameters [#parameters]

### config? [#config]

[`CubismConfig`](/pixi-vn-live2d/core/interfaces/CubismConfig)

## Returns [#returns]

`void`


# Function: remove() (/pixi-vn-live2d/core/functions/remove)



\> **remove**\<`T`>(`array`, `item`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4871

Remove an element from array.

## Type Parameters [#type-parameters]

### T [#t]

`T`

## Parameters [#parameters]

### array [#array]

`T`\[]

### item [#item]

`T`

## Returns [#returns]

`void`


# Function: resolveURL() (/pixi-vn-live2d/core/functions/resolveURL)



\> **resolveURL**(`base`, `path`): `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4875

Resolves a path/URL against a base string without relying on Node's `url` module.

## Parameters [#parameters]

### base [#base]

`string`

### path [#path]

`string`

## Returns [#returns]

`string`


# Function: startUpCubism() (/pixi-vn-live2d/core/functions/startUpCubism)



\> **startUpCubism**(`options?`, `memorySizeMB?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6985

Starts up the Cubism framework.

## Parameters [#parameters]

### options? [#options]

`Option`

### memorySizeMB? [#memorysizemb]

`number`

## Returns [#returns]

`void`


# core (/pixi-vn-live2d/core)



## Namespaces [#namespaces]

* [Cubism2Spec](/pixi-vn-live2d/core/namespaces/Cubism2Spec)
* [Live2DCubismCore](/pixi-vn-live2d/core/namespaces/Live2DCubismCore)
* [Live2DObfuscated](/pixi-vn-live2d/core/namespaces/Live2DObfuscated)

## Enumerations [#enumerations]

* [EyeState](/pixi-vn-live2d/core/enumerations/EyeState)
* [MotionPreloadStrategy](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)
* [MotionPriority](/pixi-vn-live2d/core/enumerations/MotionPriority)

## Classes [#classes]

* [CubismExpressionManager](/pixi-vn-live2d/core/classes/CubismExpressionManager)
* [CubismInternalModel](/pixi-vn-live2d/core/classes/CubismInternalModel)
* [CubismLegacyExpressionManager](/pixi-vn-live2d/core/classes/CubismLegacyExpressionManager)
* [CubismLegacyInternalModel](/pixi-vn-live2d/core/classes/CubismLegacyInternalModel)
* [CubismLegacyModelSettings](/pixi-vn-live2d/core/classes/CubismLegacyModelSettings)
* [CubismLegacyMotionManager](/pixi-vn-live2d/core/classes/CubismLegacyMotionManager)
* [CubismLegacyParallelMotionManager](/pixi-vn-live2d/core/classes/CubismLegacyParallelMotionManager)
* [CubismModelSettings](/pixi-vn-live2d/core/classes/CubismModelSettings)
* [CubismMotionManager](/pixi-vn-live2d/core/classes/CubismMotionManager)
* [CubismParallelMotionManager](/pixi-vn-live2d/core/classes/CubismParallelMotionManager)
* [ExpressionManager](/pixi-vn-live2d/core/classes/ExpressionManager)
* [FileLoader](/pixi-vn-live2d/core/classes/FileLoader)
* [FocusController](/pixi-vn-live2d/core/classes/FocusController)
* [InternalModel](/pixi-vn-live2d/core/classes/InternalModel)
* [Live2DExpression](/pixi-vn-live2d/core/classes/Live2DExpression)
* [Live2DEyeBlink](/pixi-vn-live2d/core/classes/Live2DEyeBlink)
* [Live2DFactory](/pixi-vn-live2d/core/classes/Live2DFactory)
* [Live2DLoader](/pixi-vn-live2d/core/classes/Live2DLoader)
* [Live2DModel](/pixi-vn-live2d/core/classes/Live2DModel)
* [Live2DPhysics](/pixi-vn-live2d/core/classes/Live2DPhysics)
* [Live2DPose](/pixi-vn-live2d/core/classes/Live2DPose)
* [Live2DTransform](/pixi-vn-live2d/core/classes/Live2DTransform)
* [ModelSettings](/pixi-vn-live2d/core/classes/ModelSettings)
* [MotionManager](/pixi-vn-live2d/core/classes/MotionManager)
* [MotionState](/pixi-vn-live2d/core/classes/MotionState)
* [SoundManager](/pixi-vn-live2d/core/classes/SoundManager)
* [XHRLoader](/pixi-vn-live2d/core/classes/XHRLoader)

## Interfaces [#interfaces]

* [AutomatorOptions](/pixi-vn-live2d/core/interfaces/AutomatorOptions)
* [Bounds](/pixi-vn-live2d/core/interfaces/Bounds)
* [CommonHitArea](/pixi-vn-live2d/core/interfaces/CommonHitArea)
* [CommonLayout](/pixi-vn-live2d/core/interfaces/CommonLayout)
* [CreateTextureOptions](/pixi-vn-live2d/core/interfaces/CreateTextureOptions)
* [csmMotionSegmentEvaluationFunction](/pixi-vn-live2d/core/interfaces/csmMotionSegmentEvaluationFunction)
* [CubismConfig](/pixi-vn-live2d/core/interfaces/CubismConfig)
* [CubismMotionEventFunction](/pixi-vn-live2d/core/interfaces/CubismMotionEventFunction)
* [Expression](/pixi-vn-live2d/core/interfaces/Expression)
* [ExpressionManagerEvents](/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)
* [FileReferences](/pixi-vn-live2d/core/interfaces/FileReferences)
* [Group](/pixi-vn-live2d/core/interfaces/Group)
* [HitArea](/pixi-vn-live2d/core/interfaces/HitArea)
* [ICubismClippingManager](/pixi-vn-live2d/core/interfaces/ICubismClippingManager)
* [InternalModelEvents](/pixi-vn-live2d/core/interfaces/InternalModelEvents)
* [InternalModelOptions](/pixi-vn-live2d/core/interfaces/InternalModelOptions)
* [Live2DFactoryContext](/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)
* [Live2DFactoryOptions](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)
* [Live2DLoaderContext](/pixi-vn-live2d/core/interfaces/Live2DLoaderContext)
* [Live2DModelEvents](/pixi-vn-live2d/core/interfaces/Live2DModelEvents)
* [Live2DModelOptions](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)
* [Live2DMotion](/pixi-vn-live2d/core/interfaces/Live2DMotion)
* [Live2DRuntime](/pixi-vn-live2d/core/interfaces/Live2DRuntime)
* [Live2DTextureLODOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions)
* [Live2DTextureSourceOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)
* [ModelJSON](/pixi-vn-live2d/core/interfaces/ModelJSON)
* [Motion](/pixi-vn-live2d/core/interfaces/Motion)
* [MotionManagerEvents](/pixi-vn-live2d/core/interfaces/MotionManagerEvents)
* [MotionManagerOptions](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)
* [MotionStartOptions](/pixi-vn-live2d/core/interfaces/MotionStartOptions)
* [normalizedPhysicsParameterValueGetter](/pixi-vn-live2d/core/interfaces/normalizedPhysicsParameterValueGetter)
* [ParallelMotionStartOptions](/pixi-vn-live2d/core/interfaces/ParallelMotionStartOptions)
* [parseJsonObject](/pixi-vn-live2d/core/interfaces/parseJsonObject)
* [physicsScaleGetter](/pixi-vn-live2d/core/interfaces/physicsScaleGetter)
* [physicsValueGetter](/pixi-vn-live2d/core/interfaces/physicsValueGetter)
* [TextureLODPlan](/pixi-vn-live2d/core/interfaces/TextureLODPlan)
* [TextureLODPlanInput](/pixi-vn-live2d/core/interfaces/TextureLODPlanInput)

## Type Aliases [#type-aliases]

* [BeganMotionCallback](/pixi-vn-live2d/core/type-aliases/BeganMotionCallback)
* [ClippingContextConstructor](/pixi-vn-live2d/core/type-aliases/ClippingContextConstructor)
* [CubismIdHandle](/pixi-vn-live2d/core/type-aliases/CubismIdHandle)
* [CubismModelSettingJsonMixin](/pixi-vn-live2d/core/type-aliases/CubismModelSettingJsonMixin)
* [CubismMotionQueueEntryHandle](/pixi-vn-live2d/core/type-aliases/CubismMotionQueueEntryHandle)
* [ExtendedFileList](/pixi-vn-live2d/core/type-aliases/ExtendedFileList)
* [FinishedMotionCallback](/pixi-vn-live2d/core/type-aliases/FinishedMotionCallback)
* [JSONObject](/pixi-vn-live2d/core/type-aliases/JSONObject)
* [Live2DConstructor](/pixi-vn-live2d/core/type-aliases/Live2DConstructor)
* [Live2DInstruction](/pixi-vn-live2d/core/type-aliases/Live2DInstruction)
* [Live2DLoaderTarget](/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget)
* [Live2DPrepareInstruction](/pixi-vn-live2d/core/type-aliases/Live2DPrepareInstruction)
* [Live2DTextureLODFilter](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)
* [Live2DTextureLODMode](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)
* [Middleware](/pixi-vn-live2d/core/type-aliases/Middleware)
* [MotionStartRandomOptions](/pixi-vn-live2d/core/type-aliases/MotionStartRandomOptions)
* [Mutable](/pixi-vn-live2d/core/type-aliases/Mutable)
* [ParallelMotionStartRandomOptions](/pixi-vn-live2d/core/type-aliases/ParallelMotionStartRandomOptions)

## Variables [#variables]

* [config](/pixi-vn-live2d/core/variables/config)
* [Live2DPlugin](/pixi-vn-live2d/core/variables/Live2DPlugin)
* [logger](/pixi-vn-live2d/core/variables/logger)
* [LOGICAL_HEIGHT](/pixi-vn-live2d/core/variables/LOGICAL_HEIGHT)
* [LOGICAL_WIDTH](/pixi-vn-live2d/core/variables/LOGICAL_WIDTH)
* [VERSION](/pixi-vn-live2d/core/variables/VERSION)
* [VOLUME](/pixi-vn-live2d/core/variables/VOLUME)

## Functions [#functions]

* [applyMixins](/pixi-vn-live2d/core/functions/applyMixins)
* [clamp](/pixi-vn-live2d/core/functions/clamp)
* [configureCubismSDK](/pixi-vn-live2d/core/functions/configureCubismSDK)
* [copyArray](/pixi-vn-live2d/core/functions/copyArray)
* [copyProperty](/pixi-vn-live2d/core/functions/copyProperty)
* [cubismReady](/pixi-vn-live2d/core/functions/cubismReady)
* [folderName](/pixi-vn-live2d/core/functions/folderName)
* [MBToByte](/pixi-vn-live2d/core/functions/MBToByte)
* [normalizeHitAreaDefs](/pixi-vn-live2d/core/functions/normalizeHitAreaDefs)
* [rand](/pixi-vn-live2d/core/functions/rand)
* [reconfigureCubismSDK](/pixi-vn-live2d/core/functions/reconfigureCubismSDK)
* [remove](/pixi-vn-live2d/core/functions/remove)
* [resolveURL](/pixi-vn-live2d/core/functions/resolveURL)
* [startUpCubism](/pixi-vn-live2d/core/functions/startUpCubism)


# Interface: AutomatorOptions (/pixi-vn-live2d/core/interfaces/AutomatorOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4217

## Extended by [#extended-by]

* [`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

## Properties [#properties]

### autoFocus? [#autofocus]

\> `optional` **autoFocus?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when `globalpointermove` event is triggered.

#### Default [#default]

```ts
true
```

***

### autoHitTest? [#autohittest]

\> `optional` **autoHitTest?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when `pointertap` event is triggered.

#### Default [#default-1]

```ts
true
```

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` **autoInteract?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

#### Default [#default-2]

```ts
true
```

#### Deprecated [#deprecated]

since v0.5.0, reading/writing this property is equivalent to reading/writing `autoHitTest && autoFocus`.

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by `PIXI.Ticker.shared`.

#### Default [#default-3]

```ts
ture
```

***

### ticker? [#ticker]

\> `optional` **ticker?**: `Ticker`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

#### Default [#default-4]

`PIXI.Ticker.shared` from the global PIXI namespace.


# Interface: Bounds (/pixi-vn-live2d/core/interfaces/Bounds)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3107

## Properties [#properties]

### height [#height]

\> **height**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3111

***

### width [#width]

\> **width**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3110

***

### x [#x]

\> **x**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3108

***

### y [#y]

\> **y**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3109


# Interface: CommonHitArea (/pixi-vn-live2d/core/interfaces/CommonHitArea)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3101

Common hit area definition shared between all Cubism versions.

## Properties [#properties]

### id [#id]

\> **id**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3102

***

### index [#index]

\> **index**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3104

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3103


# Interface: CommonLayout (/pixi-vn-live2d/core/interfaces/CommonLayout)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:839

## Properties [#properties]

### bottom? [#bottom]

\> `optional` **bottom?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:847

***

### centerX? [#centerx]

\> `optional` **centerX?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:840

***

### centerY? [#centery]

\> `optional` **centerY?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:841

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:845

***

### left? [#left]

\> `optional` **left?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:848

***

### right? [#right]

\> `optional` **right?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:849

***

### top? [#top]

\> `optional` **top?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:846

***

### width? [#width]

\> `optional` **width?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:844

***

### x? [#x]

\> `optional` **x?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:842

***

### y? [#y]

\> `optional` **y?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:843


# Interface: CreateTextureOptions (/pixi-vn-live2d/core/interfaces/CreateTextureOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4042

Texture loading options accepted by Live2D model atlas loading.

## Extends [#extends]

* [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

## Properties [#properties]

### crossOrigin? [#crossorigin]

\> `optional` **crossOrigin?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4043

***

### lod? [#lod]

\> `optional` **lod?**: [`Live2DTextureLODMode`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3983

Selects the atlas LOD strategy for model textures.

`full` is the default and uses Pixi's mipmap generation for the original atlas.
`single-auto` creates one downsampled atlas on demand and switches to it while
rendering small models. `false` disables both paths.

#### Default [#default]

```ts
'full'
```

#### Inherited from [#inherited-from]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`lod`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#lod)

***

### lodFilter? [#lodfilter]

\> `optional` **lodFilter?**: [`Live2DTextureLODFilter`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4019

Sampling filter used while drawing the generated `single-auto` atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-1]

```ts
'linear'
```

#### Inherited from [#inherited-from-1]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`lodFilter`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#lodfilter)

***

### lodMaxLevel? [#lodmaxlevel]

\> `optional` **lodMaxLevel?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4011

Maximum generated `single-auto` LOD level. Each level halves the atlas width and
height once, so level 1 is 1/2 size and level 2 is 1/4 size.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-2]

```ts
undefined
```

#### Inherited from [#inherited-from-2]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`lodMaxLevel`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#lodmaxlevel)

***

### lodScaleThreshold? [#lodscalethreshold]

\> `optional` **lodScaleThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3993

Effective screen scale below which `single-auto` can switch to a generated
downsampled atlas. The effective scale is computed from model world scale and
renderer resolution.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-3]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`lodScaleThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#lodscalethreshold)

***

### lodTextureSizeThreshold? [#lodtexturesizethreshold]

\> `optional` **lodTextureSizeThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4002

Minimum original atlas side length required before `single-auto` considers
generating a downsampled atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-4]

```ts
4096
```

#### Inherited from [#inherited-from-4]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`lodTextureSizeThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#lodtexturesizethreshold)

***

### preferCreateImageBitmap? [#prefercreateimagebitmap]

\> `optional` **preferCreateImageBitmap?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4040

Forces Pixi to load texture resources without createImageBitmap.
Cubism 2 textures use this because their WebGL upload path depends on HTML image sources.

#### Default [#default-5]

```ts
undefined
```

#### Inherited from [#inherited-from-5]

[`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions).[`preferCreateImageBitmap`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions#prefercreateimagebitmap)


# Interface: CubismConfig (/pixi-vn-live2d/core/interfaces/CubismConfig)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6967

## Properties [#properties]

### memorySizeMB? [#memorysizemb]

\> `optional` **memorySizeMB?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6971

Memory size in megabytes for Cubism's internal heap.


# Interface: CubismMotionEventFunction() (/pixi-vn-live2d/core/interfaces/CubismMotionEventFunction)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2491

イベントのコールバック関数を定義

イベントのコールバックに登録できる関数の型情報

\> **CubismMotionEventFunction**(`caller`, `eventValue`, `customData`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2492

イベントのコールバック関数を定義

イベントのコールバックに登録できる関数の型情報

## Parameters [#parameters]

### caller [#caller]

`CubismMotionQueueManager`

発火したイベントを再生させたCubismMotionQueueManager

### eventValue [#eventvalue]

`csmString`

発火したイベントの文字列データ

### customData [#customdata]

`any`

コールバックに返される登録時に指定されたデータ

## Returns [#returns]

`void`


# Interface: Expression (/pixi-vn-live2d/core/interfaces/Expression)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5170

## Properties [#properties]

### FadeInTime? [#fadeintime]

\> `optional` **FadeInTime?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5173

***

### FadeOutTime? [#fadeouttime]

\> `optional` **FadeOutTime?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5174

***

### File [#file]

\> **File**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5172

***

### Name [#name]

\> **Name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5171


# Interface: ExpressionManagerEvents<Expression> (/pixi-vn-live2d/core/interfaces/ExpressionManagerEvents)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3733

## Type Parameters [#type-parameters]

### Expression [#expression]

`Expression` = `never`

## Events [#events]

### destroy [#destroy]

\> **destroy**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3751

* Before destroyed.

***

### expressionLoaded [#expressionloaded]

\> **expressionLoaded**: \[`Expression`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3738

* An Expression has been loaded.

#### Param [#param]

**-**

The Expression instance, varies in different Cubism version.

***

### expressionLoadError [#expressionloaderror]

\> **expressionLoadError**: \[`unknown`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3745

* An error occurs when loading an Expression.

#### Param [#param-1]

**-**

The error.


# Interface: FileReferences (/pixi-vn-live2d/core/interfaces/FileReferences)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5186

## Properties [#properties]

### Expressions? [#expressions]

\> `optional` **Expressions?**: [`Expression`](/pixi-vn-live2d/core/interfaces/Expression)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5192

***

### Moc [#moc]

\> **Moc**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5187

***

### Motions? [#motions]

\> `optional` **Motions?**: `Record`\<`string`, [`Motion`](/pixi-vn-live2d/core/interfaces/Motion)\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5193

***

### Physics? [#physics]

\> `optional` **Physics?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5189

***

### Pose? [#pose]

\> `optional` **Pose?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5190

***

### Textures [#textures]

\> **Textures**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5188

***

### UserData? [#userdata]

\> `optional` **UserData?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5191


# Interface: Group (/pixi-vn-live2d/core/interfaces/Group)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5176

## Properties [#properties]

### Ids [#ids]

\> **Ids**: (`string` | \{ `Id`: `string`; })\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5178

***

### Name [#name]

\> **Name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5177


# Interface: HitArea (/pixi-vn-live2d/core/interfaces/HitArea)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5182

## Properties [#properties]

### Id [#id]

\> **Id**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5184

***

### Name [#name]

\> **Name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5183


# Interface: ICubismClippingManager (/pixi-vn-live2d/core/interfaces/ICubismClippingManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:1241

## Methods [#methods]

### getClippingMaskBufferSize() [#getclippingmaskbuffersize]

\> **getClippingMaskBufferSize**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:1242

#### Returns [#returns]

`number`


# Interface: InternalModelEvents (/pixi-vn-live2d/core/interfaces/InternalModelEvents)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3754

## Events [#events]

### afterMotionUpdate [#aftermotionupdate]

\> **afterMotionUpdate**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3763

* After the model's parameters are updated by the motion.

***

### beforeModelUpdate [#beforemodelupdate]

\> **beforeModelUpdate**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3768

* Before the model is updated with its parameters applied.

***

### beforeMotionUpdate [#beforemotionupdate]

\> **beforeMotionUpdate**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3758

* Before the model's parameters are updated by the motion.

***

### destroy [#destroy]

\> **destroy**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3773

* Before destroyed.


# Interface: InternalModelOptions (/pixi-vn-live2d/core/interfaces/InternalModelOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3113

## Extends [#extends]

* [`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions)

## Extended by [#extended-by]

* [`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

## Properties [#properties]

### breathDepth? [#breathdepth]

\> `optional` **breathDepth?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default]

```ts
1.0
```

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3341

Whether to validate motion3.json consistency when creating motions.

#### Default [#default-1]

```ts
false
```

#### Inherited from [#inherited-from]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions).[`checkMotionConsistency`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions#checkmotionconsistency)

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-2]

```ts
true
```

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-3]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

#### Inherited from [#inherited-from-1]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions).[`idleMotionGroup`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions#idlemotiongroup)

***

### lipSyncGain? [#lipsyncgain]

\> `optional` **lipSyncGain?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

#### Default [#default-4]

```ts
1.5
```

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` **lipSyncWeight?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

#### Default [#default-5]

```ts
0.4
```

***

### motionPreload? [#motionpreload]

\> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-6]

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from [#inherited-from-2]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions).[`motionPreload`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions#motionpreload)

***

### useHighPrecisionMask? [#usehighprecisionmask]

\> `optional` **useHighPrecisionMask?**: `boolean` | `"auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering.
Only supported by Cubism 3/4/5 models.

#### Default [#default-7]

```ts
'auto'
```


# Interface: Live2DFactoryContext (/pixi-vn-live2d/core/interfaces/Live2DFactoryContext)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4084

The context transferred through the model creation middlewares.

## Properties [#properties]

### internalModel? [#internalmodel]

\> `optional` **internalModel?**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4088

***

### live2dModel [#live2dmodel]

\> **live2dModel**: [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4087

***

### options [#options]

\> **options**: [`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4086

***

### settings? [#settings]

\> `optional` **settings?**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4089

***

### source [#source]

\> **source**: `any`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4085


# Interface: Live2DFactoryOptions (/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4045

## Extends [#extends]

* [`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

## Extended by [#extended-by]

* [`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions)

## Properties [#properties]

### anchorMode? [#anchormode]

\> `optional` **anchorMode?**: `"canvas"` | `"drawable"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4293

Defines which bounds are used to resolve the normalized [Live2DModel.anchor](/pixi-vn-live2d/core/classes/Live2DModel#anchor).
`'canvas'` preserves the historical model-canvas behavior, while `'drawable'`
resolves the anchor against the visible drawable bounds.

#### Default [#default]

```ts
'canvas'
```

#### Inherited from [#inherited-from]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`anchorMode`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#anchormode)

***

### autoFocus? [#autofocus]

\> `optional` **autoFocus?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when `globalpointermove` event is triggered.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoFocus`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autofocus)

***

### autoHitTest? [#autohittest]

\> `optional` **autoHitTest?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when `pointertap` event is triggered.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-2]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoHitTest`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autohittest)

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` **autoInteract?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

#### Default [#default-3]

```ts
true
```

#### Deprecated [#deprecated]

since v0.5.0, reading/writing this property is equivalent to reading/writing `autoHitTest && autoFocus`.

#### Inherited from [#inherited-from-3]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoInteract`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autointeract)

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by `PIXI.Ticker.shared`.

#### Default [#default-4]

```ts
ture
```

#### Inherited from [#inherited-from-4]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoUpdate`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autoupdate)

***

### breathDepth? [#breathdepth]

\> `optional` **breathDepth?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default-5]

```ts
1.0
```

#### Inherited from [#inherited-from-5]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`breathDepth`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#breathdepth)

***

### checkMocConsistency? [#checkmocconsistency]

\> `optional` **checkMocConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4051

Whether to check the consistency of the moc file. It's an internal
function of Cubism core and only available since Cubism 4 R7.

#### Default [#default-6]

```ts
false
```

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4071

Whether to validate motion3.json consistency when loading motions.

#### Default [#default-7]

```ts
false
```

#### Overrides [#overrides]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`checkMotionConsistency`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#checkmotionconsistency)

***

### crossOrigin? [#crossorigin]

\> `optional` **crossOrigin?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4056

String to use for crossOrigin properties on `<img>` elements when loading textures.

#### Default [#default-8]

```ts
undefined
```

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-9]

```ts
true
```

#### Inherited from [#inherited-from-6]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`eyeBlink`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#eyeblink)

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-10]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

#### Inherited from [#inherited-from-7]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`idleMotionGroup`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#idlemotiongroup)

***

### lipSyncGain? [#lipsyncgain]

\> `optional` **lipSyncGain?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

#### Default [#default-11]

```ts
1.5
```

#### Inherited from [#inherited-from-8]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`lipSyncGain`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#lipsyncgain)

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` **lipSyncWeight?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

#### Default [#default-12]

```ts
0.4
```

#### Inherited from [#inherited-from-9]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`lipSyncWeight`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#lipsyncweight)

***

### motionPreload? [#motionpreload]

\> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-13]

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from [#inherited-from-10]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`motionPreload`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#motionpreload)

***

### textureOptions? [#textureoptions]

\> `optional` **textureOptions?**: [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4079

Texture loading and atlas LOD options.

See [Live2DTextureLODOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions) for the available `lod` strategies.

#### Default [#default-14]

```ts
{ lod: 'full' }
```

#### Overrides [#overrides-1]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`textureOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#textureoptions)

***

### ticker? [#ticker]

\> `optional` **ticker?**: `Ticker`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

#### Default [#default-15]

`PIXI.Ticker.shared` from the global PIXI namespace.

#### Inherited from [#inherited-from-11]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`ticker`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#ticker)

***

### useHighPrecisionMask? [#usehighprecisionmask]

\> `optional` **useHighPrecisionMask?**: `boolean` | `"auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering.
Only supported by Cubism 3/4/5 models.

#### Default [#default-16]

```ts
'auto'
```

#### Inherited from [#inherited-from-12]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`useHighPrecisionMask`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#usehighprecisionmask)

## Methods [#methods]

### onError()? [#onerror]

\> `optional` **onError**(`e`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4066

Callback invoked when error occurs while loading the model.

#### Parameters [#parameters]

##### e [#e]

`Error`

#### Returns [#returns]

`void`

#### Default [#default-17]

```ts
undefined
```

***

### onLoad()? [#onload]

\> `optional` **onLoad**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4061

Callback invoked when the model has been loaded.

#### Returns [#returns-1]

`void`

#### Default [#default-18]

```ts
undefined
```


# Interface: Live2DLoaderContext (/pixi-vn-live2d/core/interfaces/Live2DLoaderContext)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4705

The context transferred through Live2DLoader middlewares.

## Properties [#properties]

### result? [#result]

\> `optional` **result?**: `unknown`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4718

Loaded data.

***

### settings? [#settings]

\> `optional` **settings?**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4711

If provided, the given URL will be resolved by [ModelSettings.resolveURL](/pixi-vn-live2d/core/classes/ModelSettings#resolveurl).

***

### target? [#target]

\> `optional` **target?**: [`Live2DLoaderTarget`](/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4716

Owner of this resource. The load task will be automatically canceled
when receiving an "destroy" event from the target.

***

### type [#type]

\> **type**: `XMLHttpRequestResponseType`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4707

The XHR's response type.

***

### url [#url]

\> **url**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4709

Will be resolved by [ModelSettings.resolveURL](/pixi-vn-live2d/core/classes/ModelSettings#resolveurl) if a ModelSettings is provided.


# Interface: Live2DModelEvents (/pixi-vn-live2d/core/interfaces/Live2DModelEvents)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3651

## Events [#events]

### hit [#hit]

\> **hit**: \[`string`\[]]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3656

* One or more hit areas are hit.

#### Param [#param]

**-**

The names of *hit* hit areas.

***

### load [#load]

\> **load**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3709

* All the resources have been loaded.

***

### modelLoaded [#modelloaded]

\> **modelLoaded**: \[[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3684

* The InternalModel has been loaded.

#### Param [#param-1]

**-**

The InternalModel instance.

***

### physicsLoaded [#physicsloaded]

\> **physicsLoaded**: \[`unknown`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3698

* The Physics has been loaded.

#### Param [#param-2]

**-**

The Physics instance, varies in different Cubism version.

***

### poseLoaded [#poseloaded]

\> **poseLoaded**: \[`unknown`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3691

* The Pose has been loaded.

#### Param [#param-3]

**-**

The Pose instance, varies in different Cubism version.

***

### ready [#ready]

\> **ready**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3704

* All the essential resources have been loaded.

***

### settingsJSONLoaded [#settingsjsonloaded]

\> **settingsJSONLoaded**: \[`object`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3663

* The settings JSON has been loaded.

#### Param [#param-4]

**-**

The settings JSON object.

***

### settingsLoaded [#settingsloaded]

\> **settingsLoaded**: \[[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3670

* The ModelSettings has been loaded.

#### Param [#param-5]

**-**

The ModelSettings instance.

***

### textureLoaded [#textureloaded]

\> **textureLoaded**: \[`Texture`\<`TextureSource`\<`any`>>\[]]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3677

* The textures have all been loaded.

#### Param [#param-6]

**-**

The texture array.


# Interface: Live2DModelOptions (/pixi-vn-live2d/core/interfaces/Live2DModelOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4286

## Extends [#extends]

* [`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions)

## Extended by [#extended-by]

* [`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

## Properties [#properties]

### anchorMode? [#anchormode]

\> `optional` **anchorMode?**: `"canvas"` | `"drawable"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4293

Defines which bounds are used to resolve the normalized [Live2DModel.anchor](/pixi-vn-live2d/core/classes/Live2DModel#anchor).
`'canvas'` preserves the historical model-canvas behavior, while `'drawable'`
resolves the anchor against the visible drawable bounds.

#### Default [#default]

```ts
'canvas'
```

***

### autoFocus? [#autofocus]

\> `optional` **autoFocus?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when `globalpointermove` event is triggered.

#### Default [#default-1]

```ts
true
```

#### Inherited from [#inherited-from]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoFocus`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autofocus)

***

### autoHitTest? [#autohittest]

\> `optional` **autoHitTest?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when `pointertap` event is triggered.

#### Default [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoHitTest`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autohittest)

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` **autoInteract?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

#### Default [#default-3]

```ts
true
```

#### Deprecated [#deprecated]

since v0.5.0, reading/writing this property is equivalent to reading/writing `autoHitTest && autoFocus`.

#### Inherited from [#inherited-from-2]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoInteract`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autointeract)

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by `PIXI.Ticker.shared`.

#### Default [#default-4]

```ts
ture
```

#### Inherited from [#inherited-from-3]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoUpdate`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autoupdate)

***

### breathDepth? [#breathdepth]

\> `optional` **breathDepth?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default-5]

```ts
1.0
```

#### Inherited from [#inherited-from-4]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`breathDepth`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#breathdepth)

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3341

Whether to validate motion3.json consistency when creating motions.

#### Default [#default-6]

```ts
false
```

#### Inherited from [#inherited-from-5]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`checkMotionConsistency`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#checkmotionconsistency)

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-7]

```ts
true
```

#### Inherited from [#inherited-from-6]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`eyeBlink`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#eyeblink)

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-8]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

#### Inherited from [#inherited-from-7]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`idleMotionGroup`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#idlemotiongroup)

***

### lipSyncGain? [#lipsyncgain]

\> `optional` **lipSyncGain?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

#### Default [#default-9]

```ts
1.5
```

#### Inherited from [#inherited-from-8]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`lipSyncGain`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#lipsyncgain)

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` **lipSyncWeight?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

#### Default [#default-10]

```ts
0.4
```

#### Inherited from [#inherited-from-9]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`lipSyncWeight`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#lipsyncweight)

***

### motionPreload? [#motionpreload]

\> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-11]

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from [#inherited-from-10]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`motionPreload`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#motionpreload)

***

### textureOptions? [#textureoptions]

\> `optional` **textureOptions?**: [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4301

Texture loading and atlas LOD options for this model.

See [Live2DTextureLODOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions) for the available `lod` strategies.

#### Default [#default-12]

```ts
{ lod: 'full' }
```

***

### ticker? [#ticker]

\> `optional` **ticker?**: `Ticker`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

#### Default [#default-13]

`PIXI.Ticker.shared` from the global PIXI namespace.

#### Inherited from [#inherited-from-11]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`ticker`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#ticker)

***

### useHighPrecisionMask? [#usehighprecisionmask]

\> `optional` **useHighPrecisionMask?**: `boolean` | `"auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering.
Only supported by Cubism 3/4/5 models.

#### Default [#default-14]

```ts
'auto'
```

#### Inherited from [#inherited-from-12]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`useHighPrecisionMask`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#usehighprecisionmask)


# Interface: Live2DMotion (/pixi-vn-live2d/core/interfaces/Live2DMotion)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4884

## Properties [#properties]

### motions [#motions]

\> **motions**: `Live2DMotionCurve`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4886

## Methods [#methods]

### onFinishHandler()? [#onfinishhandler]

\> `optional` **onFinishHandler**(`motion`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4885

#### Parameters [#parameters]

##### motion [#motion]

`this`

#### Returns [#returns]

`void`


# Interface: Live2DRuntime (/pixi-vn-live2d/core/interfaces/Live2DRuntime)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4094

Represents a Cubism version.

## Properties [#properties]

### version [#version]

\> **version**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4098

The version number. Higher version takes priority when matching the runtime.

## Methods [#methods]

### createCoreModel() [#createcoremodel]

\> **createCoreModel**(`data`, `options?`): `any`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4124

Creates a core model.

#### Parameters [#parameters]

##### data [#data]

`ArrayBuffer`

Content of the moc file.

##### options? [#options]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

#### Returns [#returns]

`any`

Created core model.

***

### createInternalModel() [#createinternalmodel]

\> **createInternalModel**(`coreModel`, `settings`, `options?`): [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4132

Creates an InternalModel.

#### Parameters [#parameters-1]

##### coreModel [#coremodel]

`any`

Core model that *must* belong to this runtime.

##### settings [#settings]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

ModelSettings of this model.

##### options? [#options-1]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options that will be passed to the InternalModel's constructor.

#### Returns [#returns-1]

[`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Created InternalModel.

***

### createModelSettings() [#createmodelsettings]

\> **createModelSettings**(`json`): [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4117

Creates a ModelSettings.

#### Parameters [#parameters-2]

##### json [#json]

`object`

The settings JSON object.

#### Returns [#returns-2]

[`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Created ModelSettings.

***

### createPhysics() [#createphysics]

\> **createPhysics**(`coreModel`, `data`): `any`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4146

Creates a physics.

#### Parameters [#parameters-3]

##### coreModel [#coremodel-1]

`any`

Core model that *must* belong to this runtime.

##### data [#data-1]

`any`

Content of the physics file.

#### Returns [#returns-3]

`any`

Created physics.

***

### createPose() [#createpose]

\> **createPose**(`coreModel`, `data`): `any`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4139

Creates a pose.

#### Parameters [#parameters-4]

##### coreModel [#coremodel-2]

`any`

Core model that *must* belong to this runtime.

##### data [#data-2]

`any`

Content of the pose file.

#### Returns [#returns-4]

`any`

Created pose.

***

### isValidMoc() [#isvalidmoc]

\> **isValidMoc**(`modelData`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4111

Checks if the data is a valid moc to create the core model.

#### Parameters [#parameters-5]

##### modelData [#modeldata]

`ArrayBuffer`

The moc content.

#### Returns [#returns-5]

`boolean`

True if the data is valid.

***

### ready() [#ready]

\> **ready**(): `Promise`\<`void`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4105

#### Returns [#returns-6]

`Promise`\<`void`>

***

### test() [#test]

\> **test**(`source`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4104

Checks if the source belongs to this runtime.

#### Parameters [#parameters-6]

##### source [#source]

`any`

Either a settings JSON object or a ModelSettings instance.

#### Returns [#returns-7]

`boolean`

True if the source belongs to this runtime.


# Interface: Live2DTextureLODOptions (/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3973

## Extended by [#extended-by]

* [`TextureLODPlanInput`](/pixi-vn-live2d/core/interfaces/TextureLODPlanInput)
* [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

## Properties [#properties]

### lod? [#lod]

\> `optional` **lod?**: [`Live2DTextureLODMode`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3983

Selects the atlas LOD strategy for model textures.

`full` is the default and uses Pixi's mipmap generation for the original atlas.
`single-auto` creates one downsampled atlas on demand and switches to it while
rendering small models. `false` disables both paths.

#### Default [#default]

```ts
'full'
```

***

### lodFilter? [#lodfilter]

\> `optional` **lodFilter?**: [`Live2DTextureLODFilter`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4019

Sampling filter used while drawing the generated `single-auto` atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-1]

```ts
'linear'
```

***

### lodMaxLevel? [#lodmaxlevel]

\> `optional` **lodMaxLevel?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4011

Maximum generated `single-auto` LOD level. Each level halves the atlas width and
height once, so level 1 is 1/2 size and level 2 is 1/4 size.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-2]

```ts
undefined
```

***

### lodScaleThreshold? [#lodscalethreshold]

\> `optional` **lodScaleThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3993

Effective screen scale below which `single-auto` can switch to a generated
downsampled atlas. The effective scale is computed from model world scale and
renderer resolution.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-3]

```ts
0.5
```

***

### lodTextureSizeThreshold? [#lodtexturesizethreshold]

\> `optional` **lodTextureSizeThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4002

Minimum original atlas side length required before `single-auto` considers
generating a downsampled atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-4]

```ts
4096
```


# Interface: Live2DTextureSourceOptions (/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4034

Texture loading options accepted by Live2D model atlas loading.

## Extends [#extends]

* [`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions)

## Extended by [#extended-by]

* [`CreateTextureOptions`](/pixi-vn-live2d/core/interfaces/CreateTextureOptions)

## Properties [#properties]

### lod? [#lod]

\> `optional` **lod?**: [`Live2DTextureLODMode`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3983

Selects the atlas LOD strategy for model textures.

`full` is the default and uses Pixi's mipmap generation for the original atlas.
`single-auto` creates one downsampled atlas on demand and switches to it while
rendering small models. `false` disables both paths.

#### Default [#default]

```ts
'full'
```

#### Inherited from [#inherited-from]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lod`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lod)

***

### lodFilter? [#lodfilter]

\> `optional` **lodFilter?**: [`Live2DTextureLODFilter`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4019

Sampling filter used while drawing the generated `single-auto` atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-1]

```ts
'linear'
```

#### Inherited from [#inherited-from-1]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodFilter`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodfilter)

***

### lodMaxLevel? [#lodmaxlevel]

\> `optional` **lodMaxLevel?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4011

Maximum generated `single-auto` LOD level. Each level halves the atlas width and
height once, so level 1 is 1/2 size and level 2 is 1/4 size.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-2]

```ts
undefined
```

#### Inherited from [#inherited-from-2]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodMaxLevel`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodmaxlevel)

***

### lodScaleThreshold? [#lodscalethreshold]

\> `optional` **lodScaleThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3993

Effective screen scale below which `single-auto` can switch to a generated
downsampled atlas. The effective scale is computed from model world scale and
renderer resolution.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-3]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodScaleThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodscalethreshold)

***

### lodTextureSizeThreshold? [#lodtexturesizethreshold]

\> `optional` **lodTextureSizeThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4002

Minimum original atlas side length required before `single-auto` considers
generating a downsampled atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-4]

```ts
4096
```

#### Inherited from [#inherited-from-4]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodTextureSizeThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodtexturesizethreshold)

***

### preferCreateImageBitmap? [#prefercreateimagebitmap]

\> `optional` **preferCreateImageBitmap?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4040

Forces Pixi to load texture resources without createImageBitmap.
Cubism 2 textures use this because their WebGL upload path depends on HTML image sources.

#### Default [#default-5]

```ts
undefined
```


# Interface: ModelJSON (/pixi-vn-live2d/core/interfaces/ModelJSON)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5195

## Properties [#properties]

### FileReferences [#filereferences]

\> **FileReferences**: [`FileReferences`](/pixi-vn-live2d/core/interfaces/FileReferences)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5198

***

### Groups? [#groups]

\> `optional` **Groups?**: [`Group`](/pixi-vn-live2d/core/interfaces/Group)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5200

***

### HitAreas? [#hitareas]

\> `optional` **HitAreas?**: [`HitArea`](/pixi-vn-live2d/core/interfaces/HitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5202

***

### Layout? [#layout]

\> `optional` **Layout?**: `Record`\<`string`, `number`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5201

***

### Motions? [#motions]

\> `optional` **Motions?**: `Record`\<`string`, [`Motion`](/pixi-vn-live2d/core/interfaces/Motion)\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5199

***

### Name? [#name]

\> `optional` **Name?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5197

***

### Version? [#version]

\> `optional` **Version?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5196


# Interface: Motion (/pixi-vn-live2d/core/interfaces/Motion)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5164

## Properties [#properties]

### FadeInTime? [#fadeintime]

\> `optional` **FadeInTime?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5166

***

### FadeOutTime? [#fadeouttime]

\> `optional` **FadeOutTime?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5167

***

### File [#file]

\> **File**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5165

***

### Sound? [#sound]

\> `optional` **Sound?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5168


# Interface: MotionManagerEvents<Motion> (/pixi-vn-live2d/core/interfaces/MotionManagerEvents)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3712

## Type Parameters [#type-parameters]

### Motion [#motion]

`Motion` = `never`

## Events [#events]

### destroy [#destroy]

\> **destroy**: \[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3730

* Before destroyed.

***

### motionLoaded [#motionloaded]

\> **motionLoaded**: \[`Motion`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3717

* A Motion has been loaded.

#### Param [#param]

**-**

The Motion instance, varies in different Cubism version.

***

### motionLoadError [#motionloaderror]

\> **motionLoadError**: \[`unknown`]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3724

* An error occurs when loading a Motion.

#### Param [#param-1]

**-**

The error.


# Interface: MotionManagerOptions (/pixi-vn-live2d/core/interfaces/MotionManagerOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3326

## Extended by [#extended-by]

* [`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions)

## Properties [#properties]

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3341

Whether to validate motion3.json consistency when creating motions.

#### Default [#default]

```ts
false
```

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-1]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

***

### motionPreload? [#motionpreload]

\> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-2]

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)


# Interface: MotionStartOptions (/pixi-vn-live2d/core/interfaces/MotionStartOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3343

## Properties [#properties]

### expression? [#expression]

\> `optional` **expression?**: `string` | `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3346

***

### ignoreParamIds? [#ignoreparamids]

\> `optional` **ignoreParamIds?**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3350

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3354

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.

***

### onError? [#onerror]

\> `optional` **onError?**: (`e`) => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3349

#### Parameters [#parameters]

##### e [#e]

`Error`

#### Returns [#returns]

`void`

***

### onFinish? [#onfinish]

\> `optional` **onFinish?**: () => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3348

#### Returns [#returns-1]

`void`

***

### resetExpression? [#resetexpression]

\> `optional` **resetExpression?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3347

***

### sound? [#sound]

\> `optional` **sound?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3344

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3345


# Interface: ParallelMotionStartOptions (/pixi-vn-live2d/core/interfaces/ParallelMotionStartOptions)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:747

## Properties [#properties]

### ignoreParamIds? [#ignoreparamids]

\> `optional` **ignoreParamIds?**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:748

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:752

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.


# Interface: TextureLODPlan (/pixi-vn-live2d/core/interfaces/TextureLODPlan)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4026

## Properties [#properties]

### height [#height]

\> **height**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4029

***

### level [#level]

\> **level**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4027

***

### width [#width]

\> **width**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4028


# Interface: TextureLODPlanInput (/pixi-vn-live2d/core/interfaces/TextureLODPlanInput)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4021

## Extends [#extends]

* [`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions)

## Properties [#properties]

### effectiveScale [#effectivescale]

\> **effectiveScale**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4022

***

### lod? [#lod]

\> `optional` **lod?**: [`Live2DTextureLODMode`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3983

Selects the atlas LOD strategy for model textures.

`full` is the default and uses Pixi's mipmap generation for the original atlas.
`single-auto` creates one downsampled atlas on demand and switches to it while
rendering small models. `false` disables both paths.

#### Default [#default]

```ts
'full'
```

#### Inherited from [#inherited-from]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lod`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lod)

***

### lodFilter? [#lodfilter]

\> `optional` **lodFilter?**: [`Live2DTextureLODFilter`](/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4019

Sampling filter used while drawing the generated `single-auto` atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-1]

```ts
'linear'
```

#### Inherited from [#inherited-from-1]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodFilter`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodfilter)

***

### lodMaxLevel? [#lodmaxlevel]

\> `optional` **lodMaxLevel?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4011

Maximum generated `single-auto` LOD level. Each level halves the atlas width and
height once, so level 1 is 1/2 size and level 2 is 1/4 size.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-2]

```ts
undefined
```

#### Inherited from [#inherited-from-2]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodMaxLevel`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodmaxlevel)

***

### lodScaleThreshold? [#lodscalethreshold]

\> `optional` **lodScaleThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3993

Effective screen scale below which `single-auto` can switch to a generated
downsampled atlas. The effective scale is computed from model world scale and
renderer resolution.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-3]

```ts
0.5
```

#### Inherited from [#inherited-from-3]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodScaleThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodscalethreshold)

***

### lodTextureSizeThreshold? [#lodtexturesizethreshold]

\> `optional` **lodTextureSizeThreshold?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4002

Minimum original atlas side length required before `single-auto` considers
generating a downsampled atlas.

Ignored unless `lod` is `'single-auto'`.

#### Default [#default-4]

```ts
4096
```

#### Inherited from [#inherited-from-4]

[`Live2DTextureLODOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions).[`lodTextureSizeThreshold`](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions#lodtexturesizethreshold)

***

### textureHeight [#textureheight]

\> **textureHeight**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4024

***

### textureWidth [#texturewidth]

\> **textureWidth**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4023


# Interface: csmMotionSegmentEvaluationFunction() (/pixi-vn-live2d/core/interfaces/csmMotionSegmentEvaluationFunction)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2878

モーションカーブのセグメントの評価関数

\> **csmMotionSegmentEvaluationFunction**(`points`, `time`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2879

モーションカーブのセグメントの評価関数

## Parameters [#parameters]

### points [#points]

`CubismMotionPoint`\[]

モーションカーブの制御点リスト

### time [#time]

`number`

評価する時間\[秒]

## Returns [#returns]

`number`


# Interface: normalizedPhysicsParameterValueGetter() (/pixi-vn-live2d/core/interfaces/normalizedPhysicsParameterValueGetter)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6526

正規化されたパラメータの取得関数の宣言

\> **normalizedPhysicsParameterValueGetter**(`targetTranslation`, `targetAngle`, `value`, `parameterMinimunValue`, `parameterMaximumValue`, `parameterDefaultValue`, `normalizationPosition`, `normalizationAngle`, `isInverted`, `weight`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6527

正規化されたパラメータの取得関数の宣言

## Parameters [#parameters]

### targetTranslation [#targettranslation]

`CubismVector2`

// 演算結果の移動値

### targetAngle [#targetangle]

// 演算結果の角度

#### angle [#angle]

`number`

### value [#value]

`number`

// パラメータの値

### parameterMinimunValue [#parameterminimunvalue]

`number`

// パラメータの最小値

### parameterMaximumValue [#parametermaximumvalue]

`number`

// パラメータの最大値

### parameterDefaultValue [#parameterdefaultvalue]

`number`

// パラメータのデフォルト値

### normalizationPosition [#normalizationposition]

`CubismPhysicsNormalization`

// 正規化された位置

### normalizationAngle [#normalizationangle]

`CubismPhysicsNormalization`

// 正規化された角度

### isInverted [#isinverted]

`boolean`

// 値が反転されているか？

### weight [#weight]

`number`

// 重み

## Returns [#returns]

`void`


# Interface: parseJsonObject() (/pixi-vn-live2d/core/interfaces/parseJsonObject)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5676

\> **parseJsonObject**(`obj`, `map`): `JsonMap`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:5677

## Parameters [#parameters]

### obj [#obj]

`Value`

### map [#map]

`JsonMap`

## Returns [#returns]

`JsonMap`


# Interface: physicsScaleGetter() (/pixi-vn-live2d/core/interfaces/physicsScaleGetter)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6548

物理演算のスケールの取得関数の宣言

\> **physicsScaleGetter**(`translationScale`, `angleScale`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6549

## Parameters [#parameters]

### translationScale [#translationscale]

`CubismVector2`

移動値のスケール

### angleScale [#anglescale]

`number`

角度のスケール

## Returns [#returns]

`number`

スケール値


# Interface: physicsValueGetter() (/pixi-vn-live2d/core/interfaces/physicsValueGetter)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6539

物理演算の値の取得関数の宣言

\> **physicsValueGetter**(`translation`, `particles`, `particleIndex`, `isInverted`, `parentGravity`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6540

## Parameters [#parameters]

### translation [#translation]

`CubismVector2`

移動値

### particles [#particles]

`CubismPhysicsParticle`\[]

物理点のリスト

### particleIndex [#particleindex]

`number`

### isInverted [#isinverted]

`boolean`

値が反映されているか

### parentGravity [#parentgravity]

`CubismVector2`

重力

## Returns [#returns]

`number`

値


# Cubism2Spec (/pixi-vn-live2d/core/namespaces/Cubism2Spec)



## Interfaces [#interfaces]

* [Expression](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)
* [ExpressionJSON](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ExpressionJSON)
* [HitArea](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/HitArea)
* [InitOpacity](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitOpacity)
* [InitParam](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitParam)
* [Layout](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Layout)
* [ModelJSON](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ModelJSON)
* [Motion](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)
* [PhysicsJSON](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PhysicsJSON)
* [PoseJSON](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PoseJSON)


# Interface: Expression (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4927

## Properties [#properties]

### file [#file]

\> **file**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4930

`*.json` file.

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4928


# Interface: ExpressionJSON (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ExpressionJSON)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4944

## Properties [#properties]

### fade_in? [#fade_in]

\> `optional` **fade_in?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4945

***

### fade_out? [#fade_out]

\> `optional` **fade_out?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4946

***

### params? [#params]

\> `optional` **params?**: `object`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4947

#### calc? [#calc]

\> `optional` **calc?**: `"add"` | `"set"` | `"mult"`

#### def? [#def]

\> `optional` **def?**: `number`

#### id [#id]

\> **id**: `string`

#### val [#val]

\> **val**: `number`


# Interface: HitArea (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/HitArea)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4932

## Properties [#properties]

### id [#id]

\> **id**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4934

***

### name [#name]

\> **name**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4933


# Interface: InitOpacity (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitOpacity)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4940

## Properties [#properties]

### id [#id]

\> **id**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4941

***

### value [#value]

\> **value**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4942


# Interface: InitParam (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitParam)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4936

## Properties [#properties]

### id [#id]

\> **id**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4937

***

### value [#value]

\> **value**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4938


# Interface: Layout (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Layout)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4905

## Properties [#properties]

### bottom? [#bottom]

\> `optional` **bottom?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4913

***

### center_x? [#center_x]

\> `optional` **center_x?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4910

***

### center_y? [#center_y]

\> `optional` **center_y?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4911

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4907

***

### left? [#left]

\> `optional` **left?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4914

***

### right? [#right]

\> `optional` **right?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4915

***

### top? [#top]

\> `optional` **top?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4912

***

### width? [#width]

\> `optional` **width?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4906

***

### x? [#x]

\> `optional` **x?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4908

***

### y? [#y]

\> `optional` **y?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4909


# Interface: ModelJSON (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/ModelJSON)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4889

## Properties [#properties]

### expressions? [#expressions]

\> `optional` **expressions?**: [`Expression`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Expression)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4902

***

### hit_areas? [#hit_areas]

\> `optional` **hit_areas?**: [`HitArea`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/HitArea)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4898

***

### init_opacities? [#init_opacities]

\> `optional` **init_opacities?**: [`InitOpacity`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitOpacity)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4900

***

### init_params? [#init_params]

\> `optional` **init_params?**: [`InitParam`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/InitParam)\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4899

***

### layout? [#layout]

\> `optional` **layout?**: [`Layout`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Layout)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4897

***

### model [#model]

\> **model**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4892

***

### motions? [#motions]

\> `optional` **motions?**: `Record`\<`string`, [`Motion`](/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4903

***

### name? [#name]

\> `optional` **name?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4890

***

### physics? [#physics]

\> `optional` **physics?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4894

***

### pose? [#pose]

\> `optional` **pose?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4893

***

### textures [#textures]

\> **textures**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4895


# Interface: Motion (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/Motion)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4917

## Properties [#properties]

### fade_in? [#fade_in]

\> `optional` **fade_in?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4923

Motion fade-in timeout.

***

### fade_out? [#fade_out]

\> `optional` **fade_out?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4925

Motion fade-out timeout.

***

### file [#file]

\> **file**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4919

`*.mtn` file.

***

### sound? [#sound]

\> `optional` **sound?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4921

Sound file.


# Interface: PhysicsJSON (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PhysicsJSON)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4954

## Properties [#properties]

### physics_hair? [#physics_hair]

\> `optional` **physics_hair?**: `object`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4955

#### comment [#comment]

\> **comment**: `string`

#### setup [#setup]

\> **setup**: `object`

##### setup.length [#setuplength]

\> **length**: `number`

##### setup.mass [#setupmass]

\> **mass**: `number`

##### setup.regist [#setupregist]

\> **regist**: `number`

#### src [#src]

\> **src**: `object`\[]

#### targets [#targets]

\> **targets**: `object`\[]


# Interface: PoseJSON (/pixi-vn-live2d/core/namespaces/Cubism2Spec/interfaces/PoseJSON)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4976

## Properties [#properties]

### parts_visible [#parts_visible]

\> **parts_visible**: `object`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4977

#### group [#group]

\> **group**: `object`\[]


# Class: CanvasInfo (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/CanvasInfo)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:283

Canvas information interface.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new CanvasInfo**(`modelPtr`): `CanvasInfo`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:299

Initializes instance.

#### Parameters [#parameters]

##### modelPtr [#modelptr]

`number`

Native model pointer.

#### Returns [#returns]

`CanvasInfo`

## Properties [#properties]

### CanvasHeight [#canvasheight]

\> **CanvasHeight**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:287

Height of native model canvas.

***

### CanvasOriginX [#canvasoriginx]

\> **CanvasOriginX**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:289

Coordinate origin of X axis.

***

### CanvasOriginY [#canvasoriginy]

\> **CanvasOriginY**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:291

Coordinate origin of Y axis.

***

### CanvasWidth [#canvaswidth]

\> **CanvasWidth**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:285

Width of native model canvas.

***

### PixelsPerUnit [#pixelsperunit]

\> **PixelsPerUnit**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:293

Pixels per unit of native model.


# Class: Drawables (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Drawables)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:348

Cubism model drawables

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Drawables**(`modelPtr`): `Drawables`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:394

Initializes instance.

#### Parameters [#parameters]

##### modelPtr [#modelptr]

`number`

Native model.

#### Returns [#returns]

`Drawables`

## Properties [#properties]

### constantFlags [#constantflags]

\> **constantFlags**: `Uint8Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:354

Constant drawable flags.

***

### count [#count]

\> **count**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:350

Drawable count.

***

### drawOrders [#draworders]

\> **drawOrders**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:360

Drawable draw orders.

***

### dynamicFlags [#dynamicflags]

\> **dynamicFlags**: `Uint8Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:356

Dynamic drawable flags.

***

### ids [#ids]

\> **ids**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:352

Drawable IDs.

***

### indexCounts [#indexcounts]

\> **indexCounts**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:376

Number of triangle indices for each drawable.

***

### indices [#indices]

\> **indices**: `Uint16Array`\<`ArrayBufferLike`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:378

Triangle index data for each drawable.

***

### maskCounts [#maskcounts]

\> **maskCounts**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:366

Mask count for each drawable.

***

### masks [#masks]

\> **masks**: `Int32Array`\<`ArrayBufferLike`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:368

Masks for each drawable.

***

### multiplyColors [#multiplycolors]

\> **multiplyColors**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:380

Information multiply color.

***

### opacities [#opacities]

\> **opacities**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:364

Drawable opacities.

***

### parentPartIndices [#parentpartindices]

\> **parentPartIndices**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:384

Indices of drawables parent part.

***

### renderOrders [#renderorders]

\> **renderOrders**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:362

Drawable render orders.

***

### screenColors [#screencolors]

\> **screenColors**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:382

Information Screen color.

***

### textureIndices [#textureindices]

\> **textureIndices**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:358

Drawable texture indices.

***

### vertexCounts [#vertexcounts]

\> **vertexCounts**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:370

Number of vertices of each drawable.

***

### vertexPositions [#vertexpositions]

\> **vertexPositions**: `Float32Array`\<`ArrayBufferLike`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:372

2D vertex position data of each drawable.

***

### vertexUvs [#vertexuvs]

\> **vertexUvs**: `Float32Array`\<`ArrayBufferLike`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:374

2D texture coordinate data of each drawables.

## Methods [#methods]

### resetDynamicFlags() [#resetdynamicflags]

\> **resetDynamicFlags**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:386

Resets all dynamic drawable flags..

#### Returns [#returns-1]

`void`


# Class: Logging (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Logging)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:199

Cubism logging.

## Methods [#methods]

### csmGetLogFunction() [#csmgetlogfunction]

\> `static` **csmGetLogFunction**(): [`csmLogFunction`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/interfaces/csmLogFunction)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:212

Queries log handler.

#### Returns [#returns]

[`csmLogFunction`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/interfaces/csmLogFunction)

Log handler.

***

### csmSetLogFunction() [#csmsetlogfunction]

\> `static` **csmSetLogFunction**(`handler`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:206

Sets log handler.

#### Parameters [#parameters]

##### handler [#handler]

[`csmLogFunction`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/interfaces/csmLogFunction)

Handler to use.

#### Returns [#returns-1]

`void`


# Class: Memory (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Memory)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:488

Memory functions.

## Methods [#methods]

### initializeAmountOfMemory() [#initializeamountofmemory]

\> `static` **initializeAmountOfMemory**(`size`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:498

HACK:
Extend memory size allocated during module initialization.
If the specified size is less than or equal to 16777216(byte), the default of 16 MB is allocated.

#### Parameters [#parameters]

##### size [#size]

`number`

allocated memory size \[byte(s)]

#### Returns [#returns]

`void`

#### See [#see]

[https://github.com/emscripten-core/emscripten/blob/main/src/settings.js#L161](https://github.com/emscripten-core/emscripten/blob/main/src/settings.js#L161)


# Class: Moc (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Moc)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:224

Cubism moc.

## Properties [#properties]

### \_ptr [#_ptr]

\> **\_ptr**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:243

Native moc.

## Methods [#methods]

### \_release() [#_release]

\> **\_release**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:241

Releases instance.

#### Returns [#returns]

`void`

***

### hasMocConsistency() [#hasmocconsistency]

\> **hasMocConsistency**(`mocBytes`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:232

Checks consistency of a moc.

#### Parameters [#parameters]

##### mocBytes [#mocbytes]

`ArrayBuffer`

Moc bytes.

#### Returns [#returns-1]

`number`

'1' if Moc is valid; '0' otherwise.

***

### fromArrayBuffer() [#fromarraybuffer]

\> `static` **fromArrayBuffer**(`buffer`): `Moc`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:239

Creates \[\[Moc]] from \[\[ArrayBuffer]].

#### Parameters [#parameters-1]

##### buffer [#buffer]

`ArrayBuffer`

Array buffer

#### Returns [#returns-2]

`Moc`

\[\[Moc]] on success; \[\[null]] otherwise.


# Class: Model (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Model)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:252

Cubism model.

## Properties [#properties]

### \_ptr [#_ptr]

\> **\_ptr**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:274

Native model.

***

### canvasinfo [#canvasinfo]

\> **canvasinfo**: [`CanvasInfo`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/CanvasInfo)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:260

Canvas information.

***

### drawables [#drawables]

\> **drawables**: [`Drawables`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Drawables)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:258

Drawables.

***

### parameters [#parameters]

\> **parameters**: [`Parameters`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parameters)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:254

Parameters.

***

### parts [#parts]

\> **parts**: [`Parts`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parts)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:256

Parts.

## Methods [#methods]

### release() [#release]

\> **release**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:272

Releases instance.

#### Returns [#returns]

`void`

***

### update() [#update]

\> **update**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:270

Updates instance.

#### Returns [#returns-1]

`void`

***

### fromMoc() [#frommoc]

\> `static` **fromMoc**(`moc`): `Model`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:268

Creates \[\[Model]] from \[\[Moc]].

#### Parameters [#parameters-1]

##### moc [#moc]

[`Moc`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Moc)

Moc

#### Returns [#returns-2]

`Model`

\[\[Model]] on success; \[\[null]] otherwise.


# Class: Parameters (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parameters)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:302

Cubism model parameters

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Parameters**(`modelPtr`): `Parameters`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:328

Initializes instance.

#### Parameters [#parameters]

##### modelPtr [#modelptr]

`number`

Native model.

#### Returns [#returns]

`Parameters`

## Properties [#properties]

### count [#count]

\> **count**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:304

Parameter count.

***

### defaultValues [#defaultvalues]

\> **defaultValues**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:314

Default parameter values.

***

### ids [#ids]

\> **ids**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:306

Parameter IDs.

***

### keyCounts [#keycounts]

\> **keyCounts**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:320

Number of key values of each parameter.

***

### keyValues [#keyvalues]

\> **keyValues**: `Float32Array`\<`ArrayBufferLike`>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:322

Key values of each parameter.

***

### maximumValues [#maximumvalues]

\> **maximumValues**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:312

Maximum parameter values.

***

### minimumValues [#minimumvalues]

\> **minimumValues**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:308

Minimum parameter values.

***

### repeats [#repeats]

\> **repeats**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:318

Parameter Repeat informations.

***

### types [#types]

\> **types**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:310

Parameter types.

***

### values [#values]

\> **values**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:316

Parameter values.


# Class: Parts (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parts)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:331

Cubism model parts

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Parts**(`modelPtr`): `Parts`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:345

Initializes instance.

#### Parameters [#parameters]

##### modelPtr [#modelptr]

`number`

Native model.

#### Returns [#returns]

`Parts`

## Properties [#properties]

### count [#count]

\> **count**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:333

Part count.

***

### ids [#ids]

\> **ids**: `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:335

Part IDs.

***

### opacities [#opacities]

\> **opacities**: `Float32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:337

Opacity values.

***

### parentIndices [#parentindices]

\> **parentIndices**: `Int32Array`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:339

Part's parent part indices.


# Class: Utils (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Utils)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:397

Utility functions.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Utils**(): `Utils`

#### Returns [#returns]

`Utils`

## Methods [#methods]

### hasBlendAdditiveBit() [#hasblendadditivebit]

\> `static` **hasBlendAdditiveBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:405

Checks whether flag is set in bitfield.

#### Parameters [#parameters]

##### bitfield [#bitfield]

`number`

Bitfield to query against.

#### Returns [#returns-1]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasBlendColorDidChangeBit() [#hasblendcolordidchangebit]

\> `static` **hasBlendColorDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:485

Checks whether flag is set in bitfield.

#### Parameters [#parameters-1]

##### bitfield [#bitfield-1]

`number`

Bitfield to query against.

#### Returns [#returns-2]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasBlendMultiplicativeBit() [#hasblendmultiplicativebit]

\> `static` **hasBlendMultiplicativeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:413

Checks whether flag is set in bitfield.

#### Parameters [#parameters-2]

##### bitfield [#bitfield-2]

`number`

Bitfield to query against.

#### Returns [#returns-3]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasDrawOrderDidChangeBit() [#hasdraworderdidchangebit]

\> `static` **hasDrawOrderDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:461

Checks whether flag is set in bitfield.

#### Parameters [#parameters-3]

##### bitfield [#bitfield-3]

`number`

Bitfield to query against.

#### Returns [#returns-4]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasIsDoubleSidedBit() [#hasisdoublesidedbit]

\> `static` **hasIsDoubleSidedBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:421

Checks whether flag is set in bitfield.

#### Parameters [#parameters-4]

##### bitfield [#bitfield-4]

`number`

Bitfield to query against.

#### Returns [#returns-5]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasIsInvertedMaskBit() [#hasisinvertedmaskbit]

\> `static` **hasIsInvertedMaskBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:429

Checks whether flag is set in bitfield.

#### Parameters [#parameters-5]

##### bitfield [#bitfield-5]

`number`

Bitfield to query against.

#### Returns [#returns-6]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasIsVisibleBit() [#hasisvisiblebit]

\> `static` **hasIsVisibleBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:437

Checks whether flag is set in bitfield.

#### Parameters [#parameters-6]

##### bitfield [#bitfield-6]

`number`

Bitfield to query against.

#### Returns [#returns-7]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasOpacityDidChangeBit() [#hasopacitydidchangebit]

\> `static` **hasOpacityDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:453

Checks whether flag is set in bitfield.

#### Parameters [#parameters-7]

##### bitfield [#bitfield-7]

`number`

Bitfield to query against.

#### Returns [#returns-8]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasRenderOrderDidChangeBit() [#hasrenderorderdidchangebit]

\> `static` **hasRenderOrderDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:469

Checks whether flag is set in bitfield.

#### Parameters [#parameters-8]

##### bitfield [#bitfield-8]

`number`

Bitfield to query against.

#### Returns [#returns-9]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasVertexPositionsDidChangeBit() [#hasvertexpositionsdidchangebit]

\> `static` **hasVertexPositionsDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:477

Checks whether flag is set in bitfield.

#### Parameters [#parameters-9]

##### bitfield [#bitfield-9]

`number`

Bitfield to query against.

#### Returns [#returns-10]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise

***

### hasVisibilityDidChangeBit() [#hasvisibilitydidchangebit]

\> `static` **hasVisibilityDidChangeBit**(`bitfield`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:445

Checks whether flag is set in bitfield.

#### Parameters [#parameters-10]

##### bitfield [#bitfield-10]

`number`

Bitfield to query against.

#### Returns [#returns-11]

`boolean`

\[\[true]] if bit set; \[\[false]] otherwise


# Class: Version (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Version)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:175

Cubism version.

## Methods [#methods]

### csmGetLatestMocVersion() [#csmgetlatestmocversion]

\> `static` **csmGetLatestMocVersion**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:187

Gets Moc file supported latest version.

#### Returns [#returns]

`number`

Moc file latest format version.

***

### csmGetMocVersion() [#csmgetmocversion]

\> `static` **csmGetMocVersion**(`moc`, `mocBytes`): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:195

Gets Moc file format version.

#### Parameters [#parameters]

##### moc [#moc]

[`Moc`](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Moc)

Moc

##### mocBytes [#mocbytes]

`ArrayBuffer`

#### Returns [#returns-1]

`number`

csmMocVersion

***

### csmGetVersion() [#csmgetversion]

\> `static` **csmGetVersion**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:181

Queries Core version.

#### Returns [#returns-2]

`number`

Core version.


# Live2DCubismCore (/pixi-vn-live2d/core/namespaces/Live2DCubismCore)



Copyright(c) Live2D Inc. All rights reserved.

Use of this source code is governed by the Live2D Proprietary Software license
that can be found at [https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_en.html](https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_en.html).

## Classes [#classes]

* [CanvasInfo](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/CanvasInfo)
* [Drawables](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Drawables)
* [Logging](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Logging)
* [Memory](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Memory)
* [Moc](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Moc)
* [Model](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Model)
* [Parameters](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parameters)
* [Parts](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Parts)
* [Utils](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Utils)
* [Version](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/classes/Version)

## Interfaces [#interfaces]

* [csmLogFunction](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/interfaces/csmLogFunction)

## Type Aliases [#type-aliases]

* [csmMocVersion](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmMocVersion)
* [csmParameterType](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmParameterType)
* [csmVersion](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmVersion)

## Variables [#variables]

* [AlignofMoc](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/AlignofMoc)
* [AlignofModel](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/AlignofModel)
* [MocVersion_30](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_30)
* [MocVersion_33](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_33)
* [MocVersion_40](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_40)
* [MocVersion_42](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_42)
* [MocVersion_50](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_50)
* [MocVersion_Unknown](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_Unknown)
* [ParameterType_BlendShape](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/ParameterType_BlendShape)
* [ParameterType_Normal](/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/ParameterType_Normal)


# Interface: csmLogFunction() (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/interfaces/csmLogFunction)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:171

Log handler.

\> **csmLogFunction**(`message`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:172

Log handler.

## Parameters [#parameters]

### message [#message]

`string`

Null-terminated string message to log.

## Returns [#returns]

`void`


# Type Alias: csmMocVersion (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmMocVersion)



\> **csmMocVersion** = `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:144

moc3 version identifier.


# Type Alias: csmParameterType (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmParameterType)



\> **csmParameterType** = `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:146

Parameter type identifier.


# Type Alias: csmVersion (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/type-aliases/csmVersion)



\> **csmVersion** = `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:142

Cubism version identifier.


# Variable: AlignofMoc (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/AlignofMoc)



\> `const` **AlignofMoc**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:148

Necessary alignment for mocs (in bytes).


# Variable: AlignofModel (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/AlignofModel)



\> `const` **AlignofModel**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:150

Necessary alignment for models (in bytes).


# Variable: MocVersion_30 (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_30)



\> `const` **MocVersion_30**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:154

.moc3 file version 3.0.00 - 3.2.07


# Variable: MocVersion_33 (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_33)



\> `const` **MocVersion_33**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:156

.moc3 file version 3.3.00 - 3.3.03


# Variable: MocVersion_40 (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_40)



\> `const` **MocVersion_40**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:158

.moc3 file version 4.0.00 - 4.1.05


# Variable: MocVersion_42 (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_42)



\> `const` **MocVersion_42**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:160

.moc3 file version 4.2.00 - 4.2.04


# Variable: MocVersion_50 (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_50)



\> `const` **MocVersion_50**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:162

.moc3 file version 5.0.00 -


# Variable: MocVersion_Unknown (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/MocVersion_Unknown)



\> `const` **MocVersion_Unknown**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:152

.moc3 file version Unknown


# Variable: ParameterType_BlendShape (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/ParameterType_BlendShape)



\> `const` **ParameterType_BlendShape**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:166

Parameter for blend shape.


# Variable: ParameterType_Normal (/pixi-vn-live2d/core/namespaces/Live2DCubismCore/variables/ParameterType_Normal)



\> `const` **ParameterType_Normal**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:164

Normal Parameter.


# Class: ClipManager (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ClipManager)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:128

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ClipManager**(): `ClipManager`

#### Returns [#returns]

`ClipManager`

## Properties [#properties]

### curFrameNo [#curframeno]

\> **curFrameNo**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:129

## Methods [#methods]

### getMaskRenderTexture() [#getmaskrendertexture]

\> **getMaskRenderTexture**(): `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:130

#### Returns [#returns-1]

`number`

***

### setupClip() [#setupclip]

\> **setupClip**(`modelContext`, `drawParam`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:131

#### Parameters [#parameters]

##### modelContext [#modelcontext]

[`ModelContext`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ModelContext)

##### drawParam [#drawparam]

[`DrawParamWebGL`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawParamWebGL)

#### Returns [#returns-2]

`void`


# Class: DrawData (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawData)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:121

## Extends [#extends]

* [`IDrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new DrawData**(): `DrawData`

#### Returns [#returns]

`DrawData`

#### Inherited from [#inherited-from]

[`IDrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData).[`constructor`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData#constructor)

## Methods [#methods]

### draw() [#draw]

\> **draw**(`aN`, `aK`, `aI`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:123

#### Parameters [#parameters]

##### aN [#an]

`unknown`

##### aK [#ak]

`unknown`

##### aI [#ai]

[`Unknown_aB`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/Unknown_aB)

#### Returns [#returns-1]

`void`

***

### getDrawDataID() [#getdrawdataid]

\> **getDrawDataID**(): `DrawDataID`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:119

#### Returns [#returns-2]

`DrawDataID`

#### Inherited from [#inherited-from-1]

[`IDrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData).[`getDrawDataID`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData#getdrawdataid)

***

### getNumPoints()? [#getnumpoints]

\> `optional` **getNumPoints**(): `unknown`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:122

#### Returns [#returns-3]

`unknown`


# Class: DrawParamWebGL (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawParamWebGL)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:90

## Constructors [#constructors]

### Constructor [#constructor]

\> **new DrawParamWebGL**(): `DrawParamWebGL`

#### Returns [#returns]

`DrawParamWebGL`

## Properties [#properties]

### \_$no [#_no]

\> **\_$no**: `WebGLBuffer` | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:102

IndexBuffer

***

### \_$NT [#_nt]

\> **\_$NT**: `WebGLBuffer` | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:98

TexCoordBuffer

***

### \_$vS [#_vs]

\> **\_$vS**: `WebGLBuffer` | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:106

PositionBuffer

***

### culling [#culling]

\> **culling**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:94

***

### firstDraw [#firstdraw]

\> **firstDraw**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:93

***

### gl [#gl]

\> **gl**: `WebGLRenderingContext`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:91

***

### glno [#glno]

\> **glno**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:92

## Methods [#methods]

### setGL() [#setgl]

\> **setGL**(`gl`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:107

#### Parameters [#parameters]

##### gl [#gl-1]

`WebGLRenderingContext`

#### Returns [#returns-1]

`void`


# Class: IDrawData (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:118

## Extended by [#extended-by]

* [`DrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawData)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new IDrawData**(): `IDrawData`

#### Returns [#returns]

`IDrawData`

## Methods [#methods]

### getDrawDataID() [#getdrawdataid]

\> **getDrawDataID**(): `DrawDataID`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:119

#### Returns [#returns-1]

`DrawDataID`


# Class: ModelContext (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ModelContext)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:109

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ModelContext**(): `ModelContext`

#### Returns [#returns]

`ModelContext`

## Properties [#properties]

### \_$aS? [#_as]

\> `optional` **\_$aS?**: `unknown`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:115

This is basically `DrawData[]`, but not reliable since it's an obfuscated property.
Always check the type before using it!

***

### clipManager [#clipmanager]

\> **clipManager**: [`ClipManager`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ClipManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:110

## Methods [#methods]

### getDrawData() [#getdrawdata]

\> **getDrawData**(`index`): [`DrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawData) | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:116

#### Parameters [#parameters]

##### index [#index]

`number`

#### Returns [#returns-1]

[`DrawData`](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawData) | `null`


# Class: MotionQueueEnt (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/MotionQueueEnt)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:83

## Constructors [#constructors]

### Constructor [#constructor]

\> **new MotionQueueEnt**(): `MotionQueueEnt`

#### Returns [#returns]

`MotionQueueEnt`

## Properties [#properties]

### \_$sr [#_sr]

\> **\_$sr**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:88

The id of the entry.

## Methods [#methods]

### isFinished() [#isfinished]

\> **isFinished**(): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:84

#### Returns [#returns-1]

`boolean`


# Class: Unknown_aB (/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/Unknown_aB)



Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:125

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Unknown_aB**(): `Unknown_aB`

#### Returns [#returns]

`Unknown_aB`

## Properties [#properties]

### baseOpacity [#baseopacity]

\> **baseOpacity**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:126


# Live2DObfuscated (/pixi-vn-live2d/core/namespaces/Live2DObfuscated)



Members that have been obfuscated.

## Classes [#classes]

* [ClipManager](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ClipManager)
* [DrawData](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawData)
* [DrawParamWebGL](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/DrawParamWebGL)
* [IDrawData](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/IDrawData)
* [ModelContext](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/ModelContext)
* [MotionQueueEnt](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/MotionQueueEnt)
* [Unknown_aB](/pixi-vn-live2d/core/namespaces/Live2DObfuscated/classes/Unknown_aB)


# Type Alias: BeganMotionCallback (/pixi-vn-live2d/core/type-aliases/BeganMotionCallback)



\> **BeganMotionCallback** = (`self`) => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2643

モーション再生開始コールバック関数定義

## Parameters [#parameters]

### self [#self]

`ACubismMotion`

## Returns [#returns]

`void`


# Type Alias: ClippingContextConstructor<T_ClippingContext> (/pixi-vn-live2d/core/type-aliases/ClippingContextConstructor)



\> **ClippingContextConstructor**\<`T_ClippingContext`> = (`manager`, `drawableMasks`, `drawableMaskCounts`) => `T_ClippingContext`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:1240

## Type Parameters [#type-parameters]

### T_ClippingContext [#t_clippingcontext]

`T_ClippingContext` *extends* `CubismClippingContext`

## Parameters [#parameters]

### manager [#manager]

`CubismClippingManager`\<`T_ClippingContext`>

### drawableMasks [#drawablemasks]

`Int32Array`

### drawableMaskCounts [#drawablemaskcounts]

`number`

## Returns [#returns]

`T_ClippingContext`


# Type Alias: CubismIdHandle (/pixi-vn-live2d/core/type-aliases/CubismIdHandle)



\> **CubismIdHandle** = `CubismId`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:941


# Type Alias: CubismModelSettingJsonMixin (/pixi-vn-live2d/core/type-aliases/CubismModelSettingJsonMixin)



\> **CubismModelSettingJsonMixin** = `Omit`\<`CubismModelSettingJson`, `"name"`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6021


# Type Alias: CubismMotionQueueEntryHandle (/pixi-vn-live2d/core/type-aliases/CubismMotionQueueEntryHandle)



\> **CubismMotionQueueEntryHandle** = `any`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2499

モーションの識別番号

モーションの識別番号の定義


# Type Alias: ExtendedFileList (/pixi-vn-live2d/core/type-aliases/ExtendedFileList)



\> **ExtendedFileList** = `File`\[] & `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4767

## Type Declaration [#type-declaration]

### settings? [#settings]

\> `optional` **settings?**: [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)


# Type Alias: FinishedMotionCallback (/pixi-vn-live2d/core/type-aliases/FinishedMotionCallback)



\> **FinishedMotionCallback** = (`self`) => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:2645

モーション再生終了コールバック関数定義

## Parameters [#parameters]

### self [#self]

`ACubismMotion`

## Returns [#returns]

`void`


# Type Alias: JSONObject (/pixi-vn-live2d/core/type-aliases/JSONObject)



\> **JSONObject** = `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:505


# Type Alias: Live2DConstructor (/pixi-vn-live2d/core/type-aliases/Live2DConstructor)



\> **Live2DConstructor** = (`options?`) => [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4303

## Parameters [#parameters]

### options? [#options]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

## Returns [#returns]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)


# Type Alias: Live2DInstruction (/pixi-vn-live2d/core/type-aliases/Live2DInstruction)



\> **Live2DInstruction** = [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel) | [`Live2DPrepareInstruction`](/pixi-vn-live2d/core/type-aliases/Live2DPrepareInstruction)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4312


# Type Alias: Live2DLoaderTarget (/pixi-vn-live2d/core/type-aliases/Live2DLoaderTarget)



\> **Live2DLoaderTarget** = [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel) | [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel) | [`MotionManager`](/pixi-vn-live2d/core/classes/MotionManager) | [`ExpressionManager`](/pixi-vn-live2d/core/classes/ExpressionManager)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4701


# Type Alias: Live2DPrepareInstruction (/pixi-vn-live2d/core/type-aliases/Live2DPrepareInstruction)



\> **Live2DPrepareInstruction** = `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4306

## Properties [#properties]

### action [#action]

\> **action**: `"prepare"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4308

***

### canBundle [#canbundle]

\> **canBundle**: `false`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4309

***

### prepare [#prepare]

\> **prepare**: () => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4310

#### Returns [#returns]

`void`

***

### renderPipeId [#renderpipeid]

\> **renderPipeId**: `"live2d"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4307


# Type Alias: Live2DTextureLODFilter (/pixi-vn-live2d/core/type-aliases/Live2DTextureLODFilter)



\> **Live2DTextureLODFilter** = `"linear"` | `"nearest"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3972

Sampling filter used while generating a `single-auto` downsampled atlas.


# Type Alias: Live2DTextureLODMode (/pixi-vn-live2d/core/type-aliases/Live2DTextureLODMode)



\> **Live2DTextureLODMode** = `false` | `"full"` | `"single-auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3968

Atlas texture LOD strategy used when loading and rendering Live2D model textures.

* `full`: ask Pixi to generate a full mipmap chain for the original atlas.
* `single-auto`: keep the original atlas, and render with one generated downsampled
  atlas when the model is small enough on screen.
* `false`: use the original atlas only.


# Type Alias: Middleware<T> (/pixi-vn-live2d/core/type-aliases/Middleware)



\> **Middleware**\<`T`> = (`context`, `next`) => `Promise`\<`void`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3959

## Type Parameters [#type-parameters]

### T [#t]

`T`

## Parameters [#parameters]

### context [#context]

`T`

### next [#next]

(`err?`) => `Promise`\<`void`>

## Returns [#returns]

`Promise`\<`void`>


# Type Alias: MotionStartRandomOptions (/pixi-vn-live2d/core/type-aliases/MotionStartRandomOptions)



\> **MotionStartRandomOptions** = `Omit`\<[`MotionStartOptions`](/pixi-vn-live2d/core/interfaces/MotionStartOptions), `"ignoreParamIds"`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3356


# Type Alias: Mutable<T> (/pixi-vn-live2d/core/type-aliases/Mutable)



\> **Mutable**\<`T`> = `{ -readonly [P in keyof T]: T[P] }`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:506

## Type Parameters [#type-parameters]

### T [#t]

`T`


# Type Alias: ParallelMotionStartRandomOptions (/pixi-vn-live2d/core/type-aliases/ParallelMotionStartRandomOptions)



\> **ParallelMotionStartRandomOptions** = `Omit`\<[`ParallelMotionStartOptions`](/pixi-vn-live2d/core/interfaces/ParallelMotionStartOptions), `"ignoreParamIds"`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:754


# Variable: LOGICAL_HEIGHT (/pixi-vn-live2d/core/variables/LOGICAL_HEIGHT)



\> `const` **LOGICAL_HEIGHT**: `2` = `2`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:504


# Variable: LOGICAL_WIDTH (/pixi-vn-live2d/core/variables/LOGICAL_WIDTH)



\> `const` **LOGICAL_WIDTH**: `2` = `2`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:503


# Variable: Live2DPlugin (/pixi-vn-live2d/core/variables/Live2DPlugin)



\> `const` **Live2DPlugin**: *typeof* `Live2DPipe`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4342

PixiJS extension entry for registering the Live2D WebGL render pipe.

Register it before creating a renderer:

```ts
import { extensions } from 'pixi.js'
import { Live2DPlugin } from 'untitled-pixi-live2d-engine'

extensions.add(Live2DPlugin)
```


# Variable: VERSION (/pixi-vn-live2d/core/variables/VERSION)



\> `const` **VERSION**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4700

Consistent with the `version` in package.json.


# Variable: VOLUME (/pixi-vn-live2d/core/variables/VOLUME)



\> `const` **VOLUME**: `0.5` = `0.5`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3908


# Variable: config (/pixi-vn-live2d/core/variables/config)



\> `const` **config**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4655

Global configs.

## Type Declaration [#type-declaration]

### cubism [#cubism]

\> **cubism**: *typeof* `CubismFrameworkConfig`

### expressionFadingDuration [#expressionfadingduration]

\> **expressionFadingDuration**: `number`

Default fading duration for expressions without such value specified.

### fftSize [#fftsize]

\> **fftSize**: `number`

fftSize for sound analyzer for lipsync.
Must be a power of 2 between 2^5 and 2^15, so one of: 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, and 32768.

#### Default [#default]

```ts
512
```

### idleMotionFadingDuration [#idlemotionfadingduration]

\> **idleMotionFadingDuration**: `number`

Default fading duration for idle motions without such value specified.

### LOG_LEVEL_ERROR [#log_level_error]

\> **LOG_LEVEL_ERROR**: `number`

### LOG_LEVEL_NONE [#log_level_none]

\> **LOG_LEVEL_NONE**: `number`

### LOG_LEVEL_VERBOSE [#log_level_verbose]

\> **LOG_LEVEL_VERBOSE**: `number`

### LOG_LEVEL_WARNING [#log_level_warning]

\> **LOG_LEVEL_WARNING**: `number`

### logLevel [#loglevel]

\> **logLevel**: `number`

Global log level.

#### Default [#default-1]

```ts
config.LOG_LEVEL_WARNING
```

### motionFadingDuration [#motionfadingduration]

\> **motionFadingDuration**: `number`

Default fading duration for motions without such value specified.

### motionSync [#motionsync]

\> **motionSync**: `boolean`

Deferring motion and corresponding sound until both are loaded.

### preserveExpressionOnMotion [#preserveexpressiononmotion]

\> **preserveExpressionOnMotion**: `boolean`

If false, expression will be reset to default when playing non-idle motions.

### sound [#sound]

\> **sound**: `boolean`

Enabling sound for motions.


# Variable: logger (/pixi-vn-live2d/core/variables/logger)



\> `const` **logger**: `object`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4828

A simple tagged logger.

You can replace the methods with your own ones.

```js
import { logger } from 'pixi-live2d-display';

logger.log = (tag, ...messages) => {
    console.log(tag, 'says:', ...messages);
};
```

## Type Declaration [#type-declaration]

### error() [#error]

\> **error**(`tag`, ...`messages`): `void`

#### Parameters [#parameters]

##### tag [#tag]

`string`

##### messages [#messages]

...`unknown`\[]

#### Returns [#returns]

`void`

### log() [#log]

\> **log**(`tag`, ...`messages`): `void`

#### Parameters [#parameters-1]

##### tag [#tag-1]

`string`

##### messages [#messages-1]

...`unknown`\[]

#### Returns [#returns-1]

`void`

### warn() [#warn]

\> **warn**(`tag`, ...`messages`): `void`

#### Parameters [#parameters-2]

##### tag [#tag-2]

`string`

##### messages [#messages-2]

...`unknown`\[]

#### Returns [#returns-2]

`void`


# Live2D integration for Pixi’VN (/pixi-vn-live2d)



![pixi-vn-cover](https://github.com/user-attachments/assets/5ff318a6-51ac-47a4-a5d2-fac53edc9614)

<p align="center">
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-live2d" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn-live2d?label=version" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-live2d" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/pixi-vn-live2d" alt="npm downloads per month" /></a>
  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/pixi-vn-live2d" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/pixi-vn-live2d?logo=jsdeliver" /></a>
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn-live2d" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/pixi-vn-live2d" /></a>
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord" /></a>
</p>

`@drincs/pixi-vn-live2d` is a lightweight wrapper around [`untitled-pixi-live2d-engine`](https://github.com/Untitled-Story/untitled-pixi-live2d-engine), designed specifically to integrate **Live2D** models into **Pixi’VN** projects.

The library provides Pixi’VN-friendly abstractions for using Live2D models inside visual novels, making it easier to load, manage, and display Live2D content within the Pixi’VN ecosystem.

## Example [#example]

```ts
import { canvas } from "@drincs/pixi-vn";
import { extensions } from "pixi.js";
import { Live2DPlugin } from "@drincs/pixi-vn-live2d/core";
import { Live2D } from "@drincs/pixi-vn-live2d";

// Register the Live2D render pipe before creating the Pixi'VN canvas application
extensions.add(Live2DPlugin);
Assets.add({ alias: "haru", src: "https://example.com/model/model3.json" });

const live2d = new Live2D({ source: "haru" });
await live2d.ready;
live2d.anchor.set(0.5);
live2d.x = canvas.width / 2;
live2d.y = canvas.height;

live2d.motion("Idle");

canvas.add("live2d", live2d);
```

## Build [#build]

To build the library, run the following command:

```bash
npm run build
```


# Class: Live2D (/pixi-vn-live2d/index/classes/Live2D)



Defined in: [src/components/Live2D.ts:63](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L63)

Live2D component for Pixi.js, used to display Live2D components.

## Example [#example]

```ts
import { Assets, canvas } from "@drincs/pixi-vn";
import { Live2D } from "@drincs/pixi-vn-live2d";

// Register an alias so the source can be swapped from a single place
// (and so it can be reloaded from memory even if the URL changes later).
Assets.add({ alias: "haru", src: "https://example.com/model/model3.json" });

const live2d = new Live2D({ source: "haru", align: { x: 0.5, y: 1 } });
await live2d.ready;

live2d.motion("Idle");

canvas.add("live2d", live2d);
```

## Extends [#extends]

* [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)

## Implements [#implements]

* `CanvasBaseItem`\<[`Live2DMemory`](/pixi-vn-live2d/index/interfaces/Live2DMemory)>
* `ListenerExtension`
* `AdditionalPositionsExtension`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new Live2D**(`options`): `Live2D`

Defined in: [src/components/Live2D.ts:67](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L67)

#### Parameters [#parameters]

##### options [#options]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions)

#### Returns [#returns]

`Live2D`

#### Overrides [#overrides]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`constructor`](/pixi-vn-live2d/core/classes/Live2DModel#constructor)

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`__devtoolIgnore`](/pixi-vn-live2d/core/classes/Live2DModel#__devtoolignore)

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`__devtoolIgnoreChildren`](/pixi-vn-live2d/core/classes/Live2DModel#__devtoolignorechildren)

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`__devtoolLocked`](/pixi-vn-live2d/core/classes/Live2DModel#__devtoollocked)

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-3]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_cx`](/pixi-vn-live2d/core/classes/Live2DModel#_cx)

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-4]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_cy`](/pixi-vn-live2d/core/classes/Live2DModel#_cy)

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-5]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_pivot`](/pixi-vn-live2d/core/classes/Live2DModel#_pivot)

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-6]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_position`](/pixi-vn-live2d/core/classes/Live2DModel#_position)

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-7]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_scale`](/pixi-vn-live2d/core/classes/Live2DModel#_scale)

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-8]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_skew`](/pixi-vn-live2d/core/classes/Live2DModel#_skew)

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-9]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_sx`](/pixi-vn-live2d/core/classes/Live2DModel#_sx)

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-10]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_sy`](/pixi-vn-live2d/core/classes/Live2DModel#_sy)

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-11]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_zIndex`](/pixi-vn-live2d/core/classes/Live2DModel#_zindex)

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-12]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessible`](/pixi-vn-live2d/core/classes/Live2DModel#accessible)

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-13]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessibleChildren`](/pixi-vn-live2d/core/classes/Live2DModel#accessiblechildren)

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-14]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessibleHint`](/pixi-vn-live2d/core/classes/Live2DModel#accessiblehint)

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-15]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessiblePointerEvents`](/pixi-vn-live2d/core/classes/Live2DModel#accessiblepointerevents)

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-16]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessibleText`](/pixi-vn-live2d/core/classes/Live2DModel#accessibletext)

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-17]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessibleTitle`](/pixi-vn-live2d/core/classes/Live2DModel#accessibletitle)

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-18]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`accessibleType`](/pixi-vn-live2d/core/classes/Live2DModel#accessibletype)

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:10

**`Internal`**

#### Inherited from [#inherited-from-19]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`allowChildren`](/pixi-vn-live2d/core/classes/Live2DModel#allowchildren)

***

### anchor [#anchor]

\> **anchor**: `ObservablePoint`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4423

The anchor behaves like the one in `PIXI.Sprite`, where `(0, 0)` means the top left
and `(1, 1)` means the bottom right.

#### Inherited from [#inherited-from-20]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`anchor`](/pixi-vn-live2d/core/classes/Live2DModel#anchor)

***

### anchorMode [#anchormode]

\> `readonly` **anchorMode**: `NonNullable`\<`"canvas"` | `"drawable"` | `undefined`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4411

#### Inherited from [#inherited-from-21]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`anchorMode`](/pixi-vn-live2d/core/classes/Live2DModel#anchormode)

***

### automator [#automator]

\> **automator**: `Automator`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4459

The Automator instance that controls model automation.

#### Inherited from [#inherited-from-22]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`automator`](/pixi-vn-live2d/core/classes/Live2DModel#automator)

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-23]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`boundsArea`](/pixi-vn-live2d/core/classes/Live2DModel#boundsarea)

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-24]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cacheAsBitmap`](/pixi-vn-live2d/core/classes/Live2DModel#cacheasbitmap)

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* Container#updateCacheTexture For updating cached content
* [Container#isCachedAsTexture](/pixi-vn-live2d/core/classes/Live2DModel#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-25]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cacheAsTexture`](/pixi-vn-live2d/core/classes/Live2DModel#cacheastexture)

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-26]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`children`](/pixi-vn-live2d/core/classes/Live2DModel#children)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-27]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cullable`](/pixi-vn-live2d/core/classes/Live2DModel#cullable)

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-28]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cullableChildren`](/pixi-vn-live2d/core/classes/Live2DModel#cullablechildren)

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-29]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cullArea`](/pixi-vn-live2d/core/classes/Live2DModel#cullarea)

***

### currentGlId [#currentglid]

\> **currentGlId**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4460

#### Inherited from [#inherited-from-30]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`currentGlId`](/pixi-vn-live2d/core/classes/Live2DModel#currentglid)

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-31]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cursor`](/pixi-vn-live2d/core/classes/Live2DModel#cursor)

***

### deltaTime [#deltatime]

\> **deltaTime**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4454

Elapsed time in milliseconds from last frame to this frame.

#### Inherited from [#inherited-from-32]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`deltaTime`](/pixi-vn-live2d/core/classes/Live2DModel#deltatime)

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-33]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`depthOfChildModified`](/pixi-vn-live2d/core/classes/Live2DModel#depthofchildmodified)

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

Container#destroy For destroying objects

#### Inherited from [#inherited-from-34]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`destroyed`](/pixi-vn-live2d/core/classes/Live2DModel#destroyed)

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-35]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`effects`](/pixi-vn-live2d/core/classes/Live2DModel#effects)

***

### elapsedTime [#elapsedtime]

\> **elapsedTime**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4449

Elapsed time in milliseconds since created.

#### Inherited from [#inherited-from-36]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`elapsedTime`](/pixi-vn-live2d/core/classes/Live2DModel#elapsedtime)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-37]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`eventMode`](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* Container#filters For applying filters
* Rectangle For area definition

#### Inherited from [#inherited-from-38]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`filterArea`](/pixi-vn-live2d/core/classes/Live2DModel#filterarea)

***

### gl [#gl]

\> `protected` **gl**: `WebGL2RenderingContext` | `null`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4444

An ID of Gl context that syncs with `renderer.CONTEXT_UID`. Used to check if the GL context has changed.

#### Inherited from [#inherited-from-39]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`gl`](/pixi-vn-live2d/core/classes/Live2DModel#gl)

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-40]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`globalDisplayStatus`](/pixi-vn-live2d/core/classes/Live2DModel#globaldisplaystatus)

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-41]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`groupAlpha`](/pixi-vn-live2d/core/classes/Live2DModel#groupalpha)

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-42]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`groupBlendMode`](/pixi-vn-live2d/core/classes/Live2DModel#groupblendmode)

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-43]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`groupColor`](/pixi-vn-live2d/core/classes/Live2DModel#groupcolor)

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-44]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`groupColorAlpha`](/pixi-vn-live2d/core/classes/Live2DModel#groupcoloralpha)

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-45]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`groupTransform`](/pixi-vn-live2d/core/classes/Live2DModel#grouptransform)

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-46]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`hitArea`](/pixi-vn-live2d/core/classes/Live2DModel#hitarea)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-47]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactive`](/pixi-vn-live2d/core/classes/Live2DModel#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-48]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactiveChildren`](/pixi-vn-live2d/core/classes/Live2DModel#interactivechildren)

***

### internalModel [#internalmodel]

\> **internalModel**: [`InternalModel`](/pixi-vn-live2d/core/classes/InternalModel)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4404

The internal model. Though typed as non-nullable, it'll be undefined until the "ready" event is emitted.

#### Inherited from [#inherited-from-49]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`internalModel`](/pixi-vn-live2d/core/classes/Live2DModel#internalmodel)

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* Container#cacheAsTexture For enabling caching
* Container#updateCacheTexture For updating cache

#### Inherited from [#inherited-from-50]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`isCachedAsTexture`](/pixi-vn-live2d/core/classes/Live2DModel#iscachedastexture)

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-51]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`isInteractive`](/pixi-vn-live2d/core/classes/Live2DModel#isinteractive)

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`label`](/pixi-vn-live2d/core/classes/Live2DModel#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-53]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`layerParentId`](/pixi-vn-live2d/core/classes/Live2DModel#layerparentid)

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-54]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`localAlpha`](/pixi-vn-live2d/core/classes/Live2DModel#localalpha)

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-55]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`localBlendMode`](/pixi-vn-live2d/core/classes/Live2DModel#localblendmode)

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-56]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`localColor`](/pixi-vn-live2d/core/classes/Live2DModel#localcolor)

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-57]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`localDisplayStatus`](/pixi-vn-live2d/core/classes/Live2DModel#localdisplaystatus)

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* [Container#worldTransform](/pixi-vn-live2d/core/classes/Live2DModel#worldtransform) For global transform
* [Container#groupTransform](/pixi-vn-live2d/core/classes/Live2DModel#grouptransform) For render group transform

#### Inherited from [#inherited-from-58]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`localTransform`](/pixi-vn-live2d/core/classes/Live2DModel#localtransform)

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](/pixi-vn-live2d/core/classes/Live2DModel#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](/pixi-vn-live2d/core/classes/Live2DModel#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-59]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`mask`](/pixi-vn-live2d/core/classes/Live2DModel#mask)

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`name`](/pixi-vn-live2d/core/classes/Live2DModel#name)

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onclick`](/pixi-vn-live2d/core/classes/Live2DModel#onclick)

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: `OnEventsHandlers` = `{}`

Defined in: [src/components/Live2D.ts:315](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L315)

ListenerExtension

#### Implementation of [#implementation-of]

`ListenerExtension.onEventsHandlers`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-62]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobalmousemove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-63]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobalpointermove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-64]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobaltouchmove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-65]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmousedown`](/pixi-vn-live2d/core/classes/Live2DModel#onmousedown)

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-66]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseenter`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseenter)

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-67]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseleave`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseleave)

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-68]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmousemove`](/pixi-vn-live2d/core/classes/Live2DModel#onmousemove)

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-69]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseout`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseout)

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-70]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseover`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseover)

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-71]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseup`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-72]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-73]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointercancel`](/pixi-vn-live2d/core/classes/Live2DModel#onpointercancel)

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-74]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerdown`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerdown)

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-75]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerenter`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerenter)

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-76]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerleave`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerleave)

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-77]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointermove`](/pixi-vn-live2d/core/classes/Live2DModel#onpointermove)

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-78]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerout`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerout)

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-79]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerover`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerover)

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-80]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointertap`](/pixi-vn-live2d/core/classes/Live2DModel#onpointertap)

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-81]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerup`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-82]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerupoutside)

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-83]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onRender`](/pixi-vn-live2d/core/classes/Live2DModel#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-84]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightclick`](/pixi-vn-live2d/core/classes/Live2DModel#onrightclick)

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-85]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightdown`](/pixi-vn-live2d/core/classes/Live2DModel#onrightdown)

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-86]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightup`](/pixi-vn-live2d/core/classes/Live2DModel#onrightup)

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-87]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onrightupoutside)

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-88]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontap`](/pixi-vn-live2d/core/classes/Live2DModel#ontap)

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-89]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchcancel`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchcancel)

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-90]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchend`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-91]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchendoutside`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-92]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchmove`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchmove)

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-93]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchstart`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchstart)

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-94]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onwheel`](/pixi-vn-live2d/core/classes/Live2DModel#onwheel)

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-95]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`parent`](/pixi-vn-live2d/core/classes/Live2DModel#parent)

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-96]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`parentRenderLayer`](/pixi-vn-live2d/core/classes/Live2DModel#parentrenderlayer)

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `CANVAS_LIVE2D_ID`

Defined in: [src/components/Live2D.ts:144](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L144)

Get the id of the canvas element. This variable is used in the system to get the canvas element by id

#### Implementation of [#implementation-of-1]

`CanvasBaseItem.pixivnId`

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-97]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`relativeGroupTransform`](/pixi-vn-live2d/core/classes/Live2DModel#relativegrouptransform)

***

### renderLive2D [#renderlive2d]

\> **renderLive2D**: (`renderer`) => `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4633

Renders the Live2DModel to the renderer.

#### Parameters [#parameters-2]

##### renderer [#renderer]

`Renderer`

The PixiJS Renderer instance.

#### Returns [#returns-4]

`void`

#### Inherited from [#inherited-from-98]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`renderLive2D`](/pixi-vn-live2d/core/classes/Live2DModel#renderlive2d)

***

### renderPipeId [#renderpipeid]

\> **renderPipeId**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4354

**`Internal`**

#### Inherited from [#inherited-from-99]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`renderPipeId`](/pixi-vn-live2d/core/classes/Live2DModel#renderpipeid)

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-100]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`sortableChildren`](/pixi-vn-live2d/core/classes/Live2DModel#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-5]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-live2d/core/classes/Live2DModel#sortablechildren) For enabling automatic sorting
* [Container#zIndex](/pixi-vn-live2d/core/classes/Live2DModel#zindex) For setting child order

#### Inherited from [#inherited-from-101]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`sortChildren`](/pixi-vn-live2d/core/classes/Live2DModel#sortchildren)

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-102]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`sortDirty`](/pixi-vn-live2d/core/classes/Live2DModel#sortdirty)

***

### sourceAlias [#sourcealias]

\> `readonly` **sourceAlias**: `string`

Defined in: [src/components/Live2D.ts:148](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L148)

The model source used to load this instance.

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-103]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`tabIndex`](/pixi-vn-live2d/core/classes/Live2DModel#tabindex)

***

### tag [#tag]

\> **tag**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4400

Tag for logging.

#### Inherited from [#inherited-from-104]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`tag`](/pixi-vn-live2d/core/classes/Live2DModel#tag)

***

### textures [#textures]

\> **textures**: `Texture`\<`TextureSource`\<`any`>>\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4409

Pixi textures.

#### Inherited from [#inherited-from-105]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`textures`](/pixi-vn-live2d/core/classes/Live2DModel#textures)

***

### transform [#transform]

\> **transform**: [`Live2DTransform`](/pixi-vn-live2d/core/classes/Live2DTransform)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4417

The Live2DTransform instance for this model.

#### Inherited from [#inherited-from-106]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`transform`](/pixi-vn-live2d/core/classes/Live2DModel#transform)

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-107]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`uid`](/pixi-vn-live2d/core/classes/Live2DModel#uid)

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-6]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-108]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`updateCacheTexture`](/pixi-vn-live2d/core/classes/Live2DModel#updatecachetexture)

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-109]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`updateTick`](/pixi-vn-live2d/core/classes/Live2DModel#updatetick)

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](/pixi-vn-live2d/core/classes/Live2DModel#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-110]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`zIndex`](/pixi-vn-live2d/core/classes/Live2DModel#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-111]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`prefixed`](/pixi-vn-live2d/core/classes/Live2DModel#prefixed)

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: [src/components/Live2D.ts:355](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L355)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-7]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: [src/components/Live2D.ts:343](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L343)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-3]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-8]

`void`

#### Implementation of [#implementation-of-2]

`AdditionalPositionsExtension.align`

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* Container#visible For toggling visibility
* Container#renderable For render control

##### Returns [#returns-9]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-4]

###### value [#value-1]

`number`

##### Returns [#returns-10]

`void`

#### Inherited from [#inherited-from-112]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`alpha`](/pixi-vn-live2d/core/classes/Live2DModel#alpha)

***

### angle [#angle]

#### Get Signature [#get-signature-2]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-66]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-11]

`number`

#### Set Signature [#set-signature-2]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-2]

`number`

##### Returns [#returns-12]

`void`

#### Inherited from [#inherited-from-113]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`angle`](/pixi-vn-live2d/core/classes/Live2DModel#angle)

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-3]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-67]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* Container#alpha For transparency
* Container#tint For color adjustments

##### Returns [#returns-13]

`BLEND_MODES`

#### Set Signature [#set-signature-3]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-3]

`BLEND_MODES`

##### Returns [#returns-14]

`void`

#### Inherited from [#inherited-from-114]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`blendMode`](/pixi-vn-live2d/core/classes/Live2DModel#blendmode)

***

### bounds [#bounds]

#### Get Signature [#get-signature-4]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4431

**`Internal`**

##### Returns [#returns-15]

`Bounds`

#### Inherited from [#inherited-from-115]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`bounds`](/pixi-vn-live2d/core/classes/Live2DModel#bounds)

***

### canBundle [#canbundle]

#### Get Signature [#get-signature-5]

\> **get** **canBundle**(): `false`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4358

**`Internal`**

##### Returns [#returns-16]

`false`

#### Inherited from [#inherited-from-116]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`canBundle`](/pixi-vn-live2d/core/classes/Live2DModel#canbundle)

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-68]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-16]

Filter For filter base class

##### Returns [#returns-17]

readonly `Filter`\[]

#### Set Signature [#set-signature-4]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-69]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-17]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-4]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-18]

`void`

#### Inherited from [#inherited-from-117]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`filters`](/pixi-vn-live2d/core/classes/Live2DModel#filters)

***

### height [#height]

#### Get Signature [#get-signature-7]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1117

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-70]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Returns [#returns-19]

`number`

#### Set Signature [#set-signature-5]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1118

##### Parameters [#parameters-8]

###### value [#value-5]

`number`

##### Returns [#returns-20]

`void`

#### Inherited from [#inherited-from-118]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`height`](/pixi-vn-live2d/core/classes/Live2DModel#height)

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-8]

\> **get** **isRenderable**(): `true`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4356

**`Internal`**

##### Returns [#returns-21]

`true`

#### Inherited from [#inherited-from-119]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`isRenderable`](/pixi-vn-live2d/core/classes/Live2DModel#isrenderable)

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-9]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-7]

##### Returns [#returns-22]

`boolean`

#### Set Signature [#set-signature-6]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-6]

`boolean`

##### Returns [#returns-23]

`void`

#### Inherited from [#inherited-from-120]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`isRenderGroup`](/pixi-vn-live2d/core/classes/Live2DModel#isrendergroup)

***

### memory [#memory]

#### Get Signature [#get-signature-10]

\> **get** **memory**(): [`Live2DMemory`](/pixi-vn-live2d/index/interfaces/Live2DMemory)

Defined in: [src/components/Live2D.ts:174](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L174)

This method return the memory of the canvas element.

##### Throws [#throws]

when the method is not overridden in the subclass.

##### Returns [#returns-24]

[`Live2DMemory`](/pixi-vn-live2d/index/interfaces/Live2DMemory)

#### Implementation of [#implementation-of-3]

`CanvasBaseItem.memory`

***

### origin [#origin]

#### Get Signature [#get-signature-11]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-71]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-25]

`ObservablePoint`

#### Set Signature [#set-signature-7]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-7]

`number` | `PointData`

##### Returns [#returns-26]

`void`

#### Inherited from [#inherited-from-121]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`origin`](/pixi-vn-live2d/core/classes/Live2DModel#origin)

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-12]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: [src/components/Live2D.ts:430](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L430)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-27]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-8]

\> **set** **percentagePosition**(`value`): `void`

Defined in: [src/components/Live2D.ts:418](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L418)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-8]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-28]

`void`

#### Implementation of [#implementation-of-4]

`AdditionalPositionsExtension.percentagePosition`

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-13]

\> **get** **percentageX**(): `number`

Defined in: [src/components/Live2D.ts:444](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L444)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-29]

`number`

#### Set Signature [#set-signature-9]

\> **set** **percentageX**(`_value`): `void`

Defined in: [src/components/Live2D.ts:436](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L436)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-30]

`void`

#### Implementation of [#implementation-of-5]

`AdditionalPositionsExtension.percentageX`

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-14]

\> **get** **percentageY**(): `number`

Defined in: [src/components/Live2D.ts:455](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L455)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-31]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageY**(`_value`): `void`

Defined in: [src/components/Live2D.ts:447](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L447)

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-32]

`void`

#### Implementation of [#implementation-of-6]

`AdditionalPositionsExtension.percentageY`

***

### pivot [#pivot]

#### Get Signature [#get-signature-15]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-72]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-33]

`ObservablePoint`

#### Set Signature [#set-signature-11]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-14]

###### value [#value-9]

`number` | `PointData`

##### Returns [#returns-34]

`void`

#### Inherited from [#inherited-from-122]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`pivot`](/pixi-vn-live2d/core/classes/Live2DModel#pivot)

***

### position [#position]

#### Get Signature [#get-signature-16]

\> **get** **position**(): `ObservablePoint`

Defined in: [src/components/Live2D.ts:526](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L526)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-73]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-35]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **position**(`value`): `void`

Defined in: [src/components/Live2D.ts:529](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L529)

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-74]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-10]

`ObservablePoint`

##### Returns [#returns-36]

`void`

#### Overrides [#overrides-1]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`position`](/pixi-vn-live2d/core/classes/Live2DModel#position)

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-17]

\> **get** **positionInfo**(): `object`

Defined in: [src/components/Live2D.ts:466](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L466)

##### Returns [#returns-37]

`object`

###### type [#type]

\> **type**: `"align"` | `"pixel"` | `"percentage"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-13]

\> **set** **positionInfo**(`value`): `void`

Defined in: [src/components/Live2D.ts:478](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L478)

##### Parameters [#parameters-16]

###### value [#value-11]

###### type? [#type-1]

`"align"` | `"pixel"` | `"percentage"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-38]

`void`

#### Implementation of [#implementation-of-7]

`AdditionalPositionsExtension.positionInfo`

***

### positionType [#positiontype]

#### Get Signature [#get-signature-18]

\> **get** **positionType**(): `"align"` | `"pixel"` | `"percentage"`

Defined in: [src/components/Live2D.ts:458](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L458)

##### Returns [#returns-39]

`"align"` | `"pixel"` | `"percentage"`

#### Implementation of [#implementation-of-8]

`AdditionalPositionsExtension.positionType`

***

### ready [#ready]

#### Get Signature [#get-signature-19]

\> **get** **ready**(): `Promise`\<`void`>

Defined in: [src/components/Live2D.ts:154](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L154)

Promise that resolves once the model resources have been loaded and it's safe to be manipulated/rendered.

##### Returns [#returns-40]

`Promise`\<`void`>

***

### renderable [#renderable]

#### Get Signature [#get-signature-20]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-75]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-18]

* Container#visible For skipping transform updates
* Container#alpha For transparency

##### Returns [#returns-41]

`boolean`

#### Set Signature [#set-signature-14]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-12]

`boolean`

##### Returns [#returns-42]

`void`

#### Inherited from [#inherited-from-123]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`renderable`](/pixi-vn-live2d/core/classes/Live2DModel#renderable)

***

### rotation [#rotation]

#### Get Signature [#get-signature-21]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-76]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-43]

`number`

#### Set Signature [#set-signature-15]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-13]

`number`

##### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-124]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`rotation`](/pixi-vn-live2d/core/classes/Live2DModel#rotation)

***

### scale [#scale]

#### Get Signature [#get-signature-22]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-77]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-45]

`ObservablePoint`

#### Set Signature [#set-signature-16]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-19]

###### value [#value-14]

`string` | `number` | `PointData`

##### Returns [#returns-46]

`void`

#### Inherited from [#inherited-from-125]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`scale`](/pixi-vn-live2d/core/classes/Live2DModel#scale)

***

### skew [#skew]

#### Get Signature [#get-signature-23]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-78]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-55]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-47]

`ObservablePoint`

#### Set Signature [#set-signature-17]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-20]

###### value [#value-15]

`PointData`

##### Returns [#returns-48]

`void`

#### Inherited from [#inherited-from-126]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`skew`](/pixi-vn-live2d/core/classes/Live2DModel#skew)

***

### tint [#tint]

#### Get Signature [#get-signature-24]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-79]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-56]

```ts
0xFFFFFF
```

##### See [#see-19]

* Container#alpha For transparency
* Container#visible For visibility control

##### Returns [#returns-49]

`number`

#### Set Signature [#set-signature-18]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-21]

###### value [#value-16]

`ColorSource`

##### Returns [#returns-50]

`void`

#### Inherited from [#inherited-from-127]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`tint`](/pixi-vn-live2d/core/classes/Live2DModel#tint)

***

### visible [#visible]

#### Get Signature [#get-signature-25]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-80]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-57]

```ts
true
```

##### See [#see-20]

* Container#renderable For render-only control
* Container#alpha For transparency

##### Returns [#returns-51]

`boolean`

#### Set Signature [#set-signature-19]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-22]

###### value [#value-17]

`boolean`

##### Returns [#returns-52]

`void`

#### Inherited from [#inherited-from-128]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`visible`](/pixi-vn-live2d/core/classes/Live2DModel#visible)

***

### width [#width]

#### Get Signature [#get-signature-26]

\> **get** **width**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1102

The width of the Container, setting this will actually modify the scale to achieve the value set.
\> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-81]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Returns [#returns-53]

`number`

#### Set Signature [#set-signature-20]

\> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1103

##### Parameters [#parameters-23]

###### value [#value-18]

`number`

##### Returns [#returns-54]

`void`

#### Inherited from [#inherited-from-129]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`width`](/pixi-vn-live2d/core/classes/Live2DModel#width)

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-27]

\> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-82]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-21]

[Container#localTransform](/pixi-vn-live2d/core/classes/Live2DModel#localtransform) For local space transform

##### Returns [#returns-55]

`Matrix`

#### Inherited from [#inherited-from-130]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`worldTransform`](/pixi-vn-live2d/core/classes/Live2DModel#worldtransform)

***

### x [#x-2]

#### Get Signature [#get-signature-28]

\> **get** **x**(): `number`

Defined in: [src/components/Live2D.ts:534](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L534)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-83]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-56]

`number`

#### Set Signature [#set-signature-21]

\> **set** **x**(`value`): `void`

Defined in: [src/components/Live2D.ts:537](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L537)

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-84]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-24]

###### value [#value-19]

`number`

##### Returns [#returns-57]

`void`

#### Overrides [#overrides-2]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`x`](/pixi-vn-live2d/core/classes/Live2DModel#x)

***

### xAlign [#xalign]

#### Get Signature [#get-signature-29]

\> **get** **xAlign**(): `number`

Defined in: [src/components/Live2D.ts:385](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L385)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-58]

`number`

#### Set Signature [#set-signature-22]

\> **set** **xAlign**(`value`): `void`

Defined in: [src/components/Live2D.ts:377](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L377)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-25]

###### value [#value-20]

`number`

##### Returns [#returns-59]

`void`

#### Implementation of [#implementation-of-9]

`AdditionalPositionsExtension.xAlign`

***

### y [#y-2]

#### Get Signature [#get-signature-30]

\> **get** **y**(): `number`

Defined in: [src/components/Live2D.ts:542](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L542)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-85]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-60]

`number`

#### Set Signature [#set-signature-23]

\> **set** **y**(`value`): `void`

Defined in: [src/components/Live2D.ts:545](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L545)

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-86]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-26]

###### value [#value-21]

`number`

##### Returns [#returns-61]

`void`

#### Overrides [#overrides-3]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`y`](/pixi-vn-live2d/core/classes/Live2DModel#y)

***

### yAlign [#yalign]

#### Get Signature [#get-signature-31]

\> **get** **yAlign**(): `number`

Defined in: [src/components/Live2D.ts:405](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L405)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-62]

`number`

#### Set Signature [#set-signature-24]

\> **set** **yAlign**(`value`): `void`

Defined in: [src/components/Live2D.ts:397](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L397)

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-22]

`number`

##### Returns [#returns-63]

`void`

#### Implementation of [#implementation-of-10]

`AdditionalPositionsExtension.yAlign`

## Methods [#methods]

### \_calculateBounds() [#_calculatebounds]

\> `protected` **\_calculateBounds**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4617

Calculates the bounds of the Live2DModel for rendering and interaction purposes.

#### Returns [#returns-64]

`void`

#### Inherited from [#inherited-from-131]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_calculateBounds`](/pixi-vn-live2d/core/classes/Live2DModel#_calculatebounds)

***

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

\> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-28]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-65]

`void`

#### Inherited from [#inherited-from-132]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`_getGlobalBoundsRecursive`](/pixi-vn-live2d/core/classes/Live2DModel#_getglobalboundsrecursive)

***

### addChild() [#addchild]

\> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-29]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-66]

`U`\[`0`]

The first child that was added

#### Example [#example-87]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-22]

* Container#removeChild For removing children
* Container#addChildAt For adding at specific index

#### Inherited from [#inherited-from-133]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`addChild`](/pixi-vn-live2d/core/classes/Live2DModel#addchild)

***

### addChildAt() [#addchildat]

\> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-1]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-30]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-67]

`U`

The child that was added

#### Example [#example-88]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-23]

* Container#addChild For adding to the end
* Container#setChildIndex For moving existing children

#### Inherited from [#inherited-from-134]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`addChildAt`](/pixi-vn-live2d/core/classes/Live2DModel#addchildat)

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

\> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-2]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-31]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-68]

`void`

##### Example [#example-89]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-135]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`addEventListener`](/pixi-vn-live2d/core/classes/Live2DModel#addeventlistener)

#### Call Signature [#call-signature-1]

\> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-32]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-69]

`void`

##### Inherited from [#inherited-from-136]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`addEventListener`](/pixi-vn-live2d/core/classes/Live2DModel#addeventlistener)

***

### addListener() [#addlistener]

\> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-3]

##### T [#t]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-33]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-70]

`this`

#### Inherited from [#inherited-from-137]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`addListener`](/pixi-vn-live2d/core/classes/Live2DModel#addlistener)

***

### collectRenderables() [#collectrenderables]

\> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4470

Insert this model into Pixi's instruction set so zIndex ordering works with other objects.

#### Parameters [#parameters-34]

##### instructionSet [#instructionset]

`InstructionSet`

##### renderer [#renderer-1]

`Renderer`

##### currentLayer [#currentlayer-1]

`RenderLayer`

#### Returns [#returns-71]

`void`

#### Inherited from [#inherited-from-138]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`collectRenderables`](/pixi-vn-live2d/core/classes/Live2DModel#collectrenderables)

***

### collectRenderablesSimple() [#collectrenderablessimple]

\> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:30

**`Internal`**

Collects renderables using a simple method, suitable for containers marked as simple.
This method iterates over the container's children and adds their renderables to the instruction set.

#### Parameters [#parameters-35]

##### instructionSet [#instructionset-1]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-72]

`void`

#### Inherited from [#inherited-from-139]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`collectRenderablesSimple`](/pixi-vn-live2d/core/classes/Live2DModel#collectrenderablessimple)

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

\> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-36]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-3]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-73]

`void`

#### Inherited from [#inherited-from-140]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`collectRenderablesWithEffects`](/pixi-vn-live2d/core/classes/Live2DModel#collectrenderableswitheffects)

***

### containsPoint() [#containspoint]

\> **containsPoint**(`point`): `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4613

A method required by `PIXI.InteractionManager` to perform hit-testing.

#### Parameters [#parameters-37]

##### point [#point]

`Point`

A Point in local space.

#### Returns [#returns-74]

`boolean`

True if the point is inside this model.

#### Inherited from [#inherited-from-141]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`containsPoint`](/pixi-vn-live2d/core/classes/Live2DModel#containspoint)

***

### destroy() [#destroy]

\> **destroy**(`options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4646

Destroys the model and all related resources. This takes the same options and also
behaves the same as `PIXI.Container#destroy`.

#### Parameters [#parameters-38]

##### options? [#options-3]

Options parameter. A boolean will act as if all options
have been set to that value

###### baseTexture? [#basetexture]

`boolean`

Only used for child Sprites if `options.children` is set to true
Should it destroy the base texture of the child sprite

###### children? [#children-2]

`boolean`

if set to true, all the children will have their destroy
method called as well. `options` will be passed on to those calls.

###### texture? [#texture]

`boolean`

Only used for child Sprites if `options.children` is set to true
Should it destroy the texture of the child sprite

#### Returns [#returns-75]

`void`

#### Inherited from [#inherited-from-142]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`destroy`](/pixi-vn-live2d/core/classes/Live2DModel#destroy)

***

### disableRenderGroup() [#disablerendergroup]

\> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-76]

`void`

#### Advanced [#advanced-8]

#### Inherited from [#inherited-from-143]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`disableRenderGroup`](/pixi-vn-live2d/core/classes/Live2DModel#disablerendergroup)

***

### dispatchEvent() [#dispatchevent]

\> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-39]

##### e [#e]

`FederatedEvent`

The event to dispatch.

#### Returns [#returns-77]

`boolean`

Whether the FederatedEvent.preventDefault preventDefault() method was not invoked.

#### Example [#example-90]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-144]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`dispatchEvent`](/pixi-vn-live2d/core/classes/Live2DModel#dispatchevent)

***

### emit() [#emit]

\> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-4]

##### T [#t-1]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-40]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-78]

`boolean`

#### Inherited from [#inherited-from-145]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`emit`](/pixi-vn-live2d/core/classes/Live2DModel#emit)

***

### enableRenderGroup() [#enablerendergroup]

\> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-79]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-146]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`enableRenderGroup`](/pixi-vn-live2d/core/classes/Live2DModel#enablerendergroup)

***

### eventNames() [#eventnames]

\> **eventNames**(): (keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-80]

(keyof ContainerEvents<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-147]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`eventNames`](/pixi-vn-live2d/core/classes/Live2DModel#eventnames)

***

### expression() [#expression]

\> **expression**(`id?`): `Promise`\<`boolean`>

Defined in: [src/components/Live2D.ts:167](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L167)

Shorthand to set an expression.

#### Parameters [#parameters-41]

##### id? [#id]

`string` | `number`

Either the index, or the name of the expression. If not presented, a random expression will be set.

#### Returns [#returns-81]

`Promise`\<`boolean`>

Promise that resolves with true if succeeded, with false otherwise.

#### Overrides [#overrides-4]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`expression`](/pixi-vn-live2d/core/classes/Live2DModel#expression)

***

### focus() [#focus]

\> **focus**(`x`, `y`, `instant?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4584

Updates the focus position. This will not cause the model to immediately look at the position,
instead the movement will be interpolated.

#### Parameters [#parameters-42]

##### x [#x-3]

`number`

Position in world space.

##### y [#y-3]

`number`

Position in world space.

##### instant? [#instant]

`boolean`

Should the focus position be instantly applied.

#### Returns [#returns-82]

`void`

#### Inherited from [#inherited-from-148]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`focus`](/pixi-vn-live2d/core/classes/Live2DModel#focus)

***

### getBounds() [#getbounds]

\> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-43]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-83]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-91]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-24]

* [Container#getLocalBounds](/pixi-vn-live2d/core/classes/Live2DModel#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-149]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getBounds`](/pixi-vn-live2d/core/classes/Live2DModel#getbounds)

***

### getChildAt() [#getchildat]

\> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-5]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-44]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-84]

`U`

The child at the given index

#### Example [#example-92]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-2]

If index is out of bounds

#### See [#see-25]

* Container#children For direct array access
* Container#getChildByLabel For name-based lookup

#### Inherited from [#inherited-from-150]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getChildAt`](/pixi-vn-live2d/core/classes/Live2DModel#getchildat)

***

### getChildByLabel() [#getchildbylabel]

\> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-45]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-85]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-93]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-26]

* Container#getChildrenByLabel For finding all matches
* [Container#label](/pixi-vn-live2d/core/classes/Live2DModel#label) For setting labels

#### Inherited from [#inherited-from-151]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getChildByLabel`](/pixi-vn-live2d/core/classes/Live2DModel#getchildbylabel)

***

### ~~getChildByName()~~ [#getchildbyname]

\> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-46]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-86]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-27]

Container#getChildByLabel

#### Inherited from [#inherited-from-152]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getChildByName`](/pixi-vn-live2d/core/classes/Live2DModel#getchildbyname)

***

### getChildIndex() [#getchildindex]

\> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-47]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-87]

`number`

The index position of the child container

#### Example [#example-94]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-3]

If child is not in this container

#### See [#see-28]

* Container#setChildIndex For changing index
* Container#children For direct array access

#### Inherited from [#inherited-from-153]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getChildIndex`](/pixi-vn-live2d/core/classes/Live2DModel#getchildindex)

***

### getChildrenByLabel() [#getchildrenbylabel]

\> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-48]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-88]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-95]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-29]

* Container#getChildByLabel For finding first match
* [Container#label](/pixi-vn-live2d/core/classes/Live2DModel#label) For setting labels

#### Inherited from [#inherited-from-154]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getChildrenByLabel`](/pixi-vn-live2d/core/classes/Live2DModel#getchildrenbylabel)

***

### getFastGlobalBounds() [#getfastglobalbounds]

\> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-49]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-89]

`Bounds`

The computed bounds.

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-155]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getFastGlobalBounds`](/pixi-vn-live2d/core/classes/Live2DModel#getfastglobalbounds)

***

### getGlobalAlpha() [#getglobalalpha]

\> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-50]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-90]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-96]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-156]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getGlobalAlpha`](/pixi-vn-live2d/core/classes/Live2DModel#getglobalalpha)

***

### getGlobalPosition() [#getglobalposition]

\> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-51]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-91]

`Point`

The updated point

#### Example [#example-97]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-30]

* [Container#toGlobal](/pixi-vn-live2d/core/classes/Live2DModel#toglobal) For converting specific points
* [Container#toLocal](/pixi-vn-live2d/core/classes/Live2DModel#tolocal) For converting to local space

#### Inherited from [#inherited-from-157]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getGlobalPosition`](/pixi-vn-live2d/core/classes/Live2DModel#getglobalposition)

***

### getGlobalTint() [#getglobaltint]

\> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-52]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-92]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-98]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-158]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getGlobalTint`](/pixi-vn-live2d/core/classes/Live2DModel#getglobaltint)

***

### getGlobalTransform() [#getglobaltransform]

\> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-53]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-93]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-99]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-159]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getGlobalTransform`](/pixi-vn-live2d/core/classes/Live2DModel#getglobaltransform)

***

### getLocalBounds() [#getlocalbounds]

\> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-94]

`Bounds`

The bounding area

#### Example [#example-100]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-31]

* [Container#getBounds](/pixi-vn-live2d/core/classes/Live2DModel#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-160]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getLocalBounds`](/pixi-vn-live2d/core/classes/Live2DModel#getlocalbounds)

***

### getSize() [#getsize]

\> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1136

Retrieves the size of the container as a \[Size]Size object.

This is faster than get the width and height separately.

#### Parameters [#parameters-54]

##### out? [#out-1]

`Size`

Optional object to store the size in.

#### Returns [#returns-95]

`Size`

The size of the container.

#### Example [#example-101]

```ts
// Basic size retrieval
const size = container.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
container.getSize(reuseSize);
```

#### Inherited from [#inherited-from-161]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`getSize`](/pixi-vn-live2d/core/classes/Live2DModel#getsize)

***

### hitTest() [#hittest]

\> **hitTest**(`x`, `y`): `string`\[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4599

Hit-test on the model.

#### Parameters [#parameters-55]

##### x [#x-4]

`number`

Position in world space.

##### y [#y-4]

`number`

Position in world space.

#### Returns [#returns-96]

`string`\[]

The names of the *hit* hit areas. Can be empty if none is hit.

#### Inherited from [#inherited-from-162]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`hitTest`](/pixi-vn-live2d/core/classes/Live2DModel#hittest)

***

### initializeOnModelLoad() [#initializeonmodelload]

\> `protected` **initializeOnModelLoad**(`_options?`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4476

A handler of the "modelLoaded" event, invoked when the internal model has been loaded.

#### Parameters [#parameters-56]

##### \_options? [#_options]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

The options used for initialization.

#### Returns [#returns-97]

`void`

#### Inherited from [#inherited-from-163]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`initializeOnModelLoad`](/pixi-vn-live2d/core/classes/Live2DModel#initializeonmodelload)

***

### listenerCount() [#listenercount]

\> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-57]

##### event [#event-2]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-98]

`number`

#### Inherited from [#inherited-from-164]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`listenerCount`](/pixi-vn-live2d/core/classes/Live2DModel#listenercount)

***

### listeners() [#listeners]

\> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-6]

##### T [#t-2]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-58]

##### event [#event-3]

`T`

#### Returns [#returns-99]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-165]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`listeners`](/pixi-vn-live2d/core/classes/Live2DModel#listeners)

***

### motion() [#motion]

\> **motion**(`group`, `index?`, `priority?`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4497

Shorthand to start a motion.

#### Parameters [#parameters-59]

##### group [#group]

`string`

The motion group.

##### index? [#index-2]

`number`

Index in the motion group.

##### priority? [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied. (0: No priority, 1: IDLE, 2:NORMAL, 3:FORCE)

##### options? [#options-4]

Additional options for motion.

###### expression? [#expression-1]

`string` | `number`

In case you want to mix up an expression while playing sound (bind with Model.expression()).

###### loop? [#loop]

`boolean`

Whether the motion should loop. Overrides Cubism 3/4/5 motion JSON loop metadata when specified.

###### onError? [#onerror]

(`e`) => `void`

Callback function when an error occurs.

###### onFinish? [#onfinish]

() => `void`

Callback function when speaking completes.

###### resetExpression? [#resetexpression]

`boolean`

Reset the expression to default after the motion is finished.

###### sound? [#sound]

`string`

The audio url to file or base64 content.

###### volume? [#volume]

`number`

Volume of the sound (0-1).

#### Returns [#returns-100]

`Promise`\<`boolean`>

Promise that resolves with true if the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-166]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`motion`](/pixi-vn-live2d/core/classes/Live2DModel#motion)

***

### motionLastFrame() [#motionlastframe]

\> **motionLastFrame**(`group`, `id`, `__namedParameters?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4506

#### Parameters [#parameters-60]

##### group [#group-1]

`string`

##### id [#id-1]

`number`

##### \_\_namedParameters? [#__namedparameters]

###### expression? [#expression-2]

`string` | `number`

#### Returns [#returns-101]

`Promise`\<`boolean`>

#### Inherited from [#inherited-from-167]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`motionLastFrame`](/pixi-vn-live2d/core/classes/Live2DModel#motionlastframe)

***

### off() [#off]

\> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-7]

##### T [#t-3]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-61]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-102]

`this`

#### Inherited from [#inherited-from-168]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`off`](/pixi-vn-live2d/core/classes/Live2DModel#off)

***

### on() [#on]

\> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: [src/components/Live2D.ts:316](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L316)

Add a listener for a given event.

#### Type Parameters [#type-parameters-8]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents<ContainerChild>

#### Parameters [#parameters-62]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-103]

`this`

#### Implementation of [#implementation-of-11]

`ListenerExtension.on`

#### Overrides [#overrides-5]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`on`](/pixi-vn-live2d/core/classes/Live2DModel#on)

***

### onAnchorChange() [#onanchorchange]

\> `protected` **onAnchorChange**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4481

A callback that observes [anchor](/pixi-vn-live2d/core/classes/Live2DModel#anchor), invoked when the anchor's values have been changed.

#### Returns [#returns-104]

`void`

#### Inherited from [#inherited-from-169]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onAnchorChange`](/pixi-vn-live2d/core/classes/Live2DModel#onanchorchange)

***

### once() [#once-1]

\> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-5]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-63]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-105]

`this`

#### Inherited from [#inherited-from-170]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`once`](/pixi-vn-live2d/core/classes/Live2DModel#once)

***

### parallelLastFrame() [#parallellastframe]

\> **parallelLastFrame**(`motionList`): `Promise`\<`boolean`\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4541

Shorthand to play the last frame of multiple motions in parallel and await their completion.

This method initiates the final frame of each specified motion concurrently,
leveraging the internal parallel motion manager. Each motion's completion is awaited
sequentially, and the results are returned as an array of success flags.

#### Parameters [#parameters-64]

##### motionList [#motionlist]

`object`\[]

Array of motions to execute.

#### Returns [#returns-106]

`Promise`\<`boolean`\[]>

Resolves with an array where each boolean indicates
whether the corresponding motion completed successfully.

#### Async [#async]

#### Inherited from [#inherited-from-171]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`parallelLastFrame`](/pixi-vn-live2d/core/classes/Live2DModel#parallellastframe)

***

### parallelMotion() [#parallelmotion]

\> **parallelMotion**(`motionList`): `Promise`\<`boolean`\[]>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4519

Shorthand to start multiple motions in parallel.

#### Parameters [#parameters-65]

##### motionList [#motionlist-1]

`object`\[]

The motion list, each item includes:
group: The motion group,
index: Index in the motion group,
priority: The priority to be applied. (0: No priority, 1: IDLE, 2:NORMAL, 3:FORCE) (default: 2)
ignoreParamIds: The ids to be ignored,
loop: Whether the motion should loop.

#### Returns [#returns-107]

`Promise`\<`boolean`\[]>

Promise that resolves with a list, indicates the motion is successfully started, with false otherwise.

#### Inherited from [#inherited-from-172]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`parallelMotion`](/pixi-vn-live2d/core/classes/Live2DModel#parallelmotion)

***

### reloadPosition() [#reloadposition]

\> `protected` **reloadPosition**(): `void`

Defined in: [src/components/Live2D.ts:487](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L487)

#### Returns [#returns-108]

`void`

***

### removeAllListeners() [#removealllisteners]

\> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-66]

##### event? [#event-7]

keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Returns [#returns-109]

`this`

#### Inherited from [#inherited-from-173]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeAllListeners`](/pixi-vn-live2d/core/classes/Live2DModel#removealllisteners)

***

### removeChild() [#removechild]

\> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-10]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-67]

##### children [#children-3]

...`U`

The Container(s) to remove

#### Returns [#returns-110]

`U`\[`0`]

The first child that was removed

#### Example [#example-102]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-32]

* Container#addChild For adding children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-174]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeChild`](/pixi-vn-live2d/core/classes/Live2DModel#removechild)

***

### removeChildAt() [#removechildat]

\> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-11]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-68]

##### index [#index-3]

`number`

The index to remove the child from

#### Returns [#returns-111]

`U`

The child that was removed

#### Example [#example-103]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-4]

If index is out of bounds

#### See [#see-33]

* Container#removeChild For removing specific children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-175]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeChildAt`](/pixi-vn-live2d/core/classes/Live2DModel#removechildat)

***

### removeChildren() [#removechildren]

\> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-69]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-112]

`ContainerChild`\[]

List of removed children

#### Example [#example-104]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-5]

If begin/end indexes are invalid

#### See [#see-34]

* Container#addChild For adding children
* Container#removeChild For removing specific children

#### Inherited from [#inherited-from-176]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeChildren`](/pixi-vn-live2d/core/classes/Live2DModel#removechildren)

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

\> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-12]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-70]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-5]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-113]

`void`

##### Inherited from [#inherited-from-177]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeEventListener`](/pixi-vn-live2d/core/classes/Live2DModel#removeeventlistener)

#### Call Signature [#call-signature-3]

\> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-71]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-6]

`RemoveListenerOptions`

##### Returns [#returns-114]

`void`

##### Inherited from [#inherited-from-178]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeEventListener`](/pixi-vn-live2d/core/classes/Live2DModel#removeeventlistener)

***

### removeFromParent() [#removefromparent]

\> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-115]

`void`

#### Example [#example-105]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-35]

* Container#addChild For adding to a new parent
* Container#removeChild For parent removing children

#### Inherited from [#inherited-from-179]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeFromParent`](/pixi-vn-live2d/core/classes/Live2DModel#removefromparent)

***

### removeListener() [#removelistener]

\> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-13]

##### T [#t-6]

`T` *extends* keyof ContainerEvents<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-72]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-116]

`this`

#### Inherited from [#inherited-from-180]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`removeListener`](/pixi-vn-live2d/core/classes/Live2DModel#removelistener)

***

### reparentChild() [#reparentchild]

\> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-14]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-73]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-117]

`U`\[`0`]

The first child that was reparented

#### Example [#example-106]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-36]

* Container#reparentChildAt For index-specific reparenting
* Container#addChild For simple parenting

#### Inherited from [#inherited-from-181]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`reparentChild`](/pixi-vn-live2d/core/classes/Live2DModel#reparentchild)

***

### reparentChildAt() [#reparentchildat]

\> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-74]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-4]

`number`

The index to reparent the child to

#### Returns [#returns-118]

`U`

The reparented child

#### Example [#example-107]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-6]

If index is out of bounds

#### See [#see-37]

* Container#reparentChild For appending reparented children
* Container#addChildAt For simple indexed parenting

#### Inherited from [#inherited-from-182]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`reparentChildAt`](/pixi-vn-live2d/core/classes/Live2DModel#reparentchildat)

***

### replaceChild() [#replacechild]

\> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-16]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-75]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-119]

`void`

#### Inherited from [#inherited-from-183]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`replaceChild`](/pixi-vn-live2d/core/classes/Live2DModel#replacechild)

***

### setChildIndex() [#setchildindex]

\> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-76]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-5]

`number`

The resulting index number for the child

#### Returns [#returns-120]

`void`

#### Example [#example-108]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-7]

If index is out of bounds

#### Throws [#throws-8]

If child is not in container

#### See [#see-38]

* Container#getChildIndex For getting current index
* Container#swapChildren For swapping positions

#### Inherited from [#inherited-from-184]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`setChildIndex`](/pixi-vn-live2d/core/classes/Live2DModel#setchildindex)

***

### setFromMatrix() [#setfrommatrix]

\> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-77]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-121]

`void`

#### Example [#example-109]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-39]

* Container#updateTransform For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-185]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`setFromMatrix`](/pixi-vn-live2d/core/classes/Live2DModel#setfrommatrix)

***

### setMask() [#setmask]

\> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-78]

##### options [#options-7]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-122]

`void`

#### Example [#example-110]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-40]

* [Container#mask](/pixi-vn-live2d/core/classes/Live2DModel#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-186]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`setMask`](/pixi-vn-live2d/core/classes/Live2DModel#setmask)

***

### setMemory() [#setmemory]

\> **setMemory**(`memory`): `Promise`\<`void`>

Defined in: [src/components/Live2D.ts:263](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L263)

This method set the memory of the canvas element.

#### Parameters [#parameters-79]

##### memory [#memory-1]

[`Live2DMemory`](/pixi-vn-live2d/index/interfaces/Live2DMemory)

#### Returns [#returns-123]

`Promise`\<`void`>

#### Throws [#throws-9]

when the method is not overridden in the subclass.

#### Implementation of [#implementation-of-12]

`CanvasBaseItem.setMemory`

***

### setSize() [#setsize]

\> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1151

Sets the size of the container to the specified width and height.
This is more efficient than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-80]

##### value [#value-23]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a \[Size]Size object.

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided.

#### Returns [#returns-124]

`void`

#### Example [#example-111]

```ts
// Basic size setting
container.setSize(100, 200);

// Set uniform size
container.setSize(100); // Sets both width and height to 100
```

#### Inherited from [#inherited-from-187]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`setSize`](/pixi-vn-live2d/core/classes/Live2DModel#setsize)

***

### speak() [#speak]

\> **speak**(`sound`, `options?`): `Promise`\<`boolean`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4560

Shorthand to start speaking a sound with an expression.

#### Parameters [#parameters-81]

##### sound [#sound-1]

`string`

The audio url to file or base64 content.

##### options? [#options-8]

Additional options for speaking.

###### expression? [#expression-3]

`string` | `number`

In case you want to mix up an expression while playing sound (bind with Model.expression()).

###### onError? [#onerror-1]

(`e`) => `void`

Callback function when an error occurs.

###### onFinish? [#onfinish-1]

() => `void`

Callback function when speaking completes.

###### resetExpression? [#resetexpression-1]

`boolean`

Reset the expression to default after the motion is finished.

###### volume? [#volume-1]

`number`

Volume of the sound (0-1).

#### Returns [#returns-125]

`Promise`\<`boolean`>

Promise that resolves with true if the sound is playing, false if it's not.

#### Inherited from [#inherited-from-188]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`speak`](/pixi-vn-live2d/core/classes/Live2DModel#speak)

***

### stopMotions() [#stopmotions]

\> **stopMotions**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4548

Stops all playing motions as well as the sound.

#### Returns [#returns-126]

`void`

#### Inherited from [#inherited-from-189]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`stopMotions`](/pixi-vn-live2d/core/classes/Live2DModel#stopmotions)

***

### stopSpeaking() [#stopspeaking]

\> **stopSpeaking**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4570

Stop current audio playback and lipsync.

#### Returns [#returns-127]

`void`

#### Inherited from [#inherited-from-190]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`stopSpeaking`](/pixi-vn-live2d/core/classes/Live2DModel#stopspeaking)

***

### swapChildren() [#swapchildren]

\> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-17]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-82]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-128]

`void`

#### Example [#example-112]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-10]

If either child is not in container

#### See [#see-41]

* Container#setChildIndex For direct index placement
* Container#getChildIndex For getting current positions

#### Inherited from [#inherited-from-191]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`swapChildren`](/pixi-vn-live2d/core/classes/Live2DModel#swapchildren)

***

### tap() [#tap]

\> **tap**(`x`, `y`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4592

Tap on the model. This will perform a hit-testing, and emit a "hit" event
if at least one of the hit areas is hit.

#### Parameters [#parameters-83]

##### x [#x-5]

`number`

Position in world space.

##### y [#y-5]

`number`

Position in world space.

#### Returns [#returns-129]

`void`

#### Emits [#emits]

[Live2DModelEvents.hit](/pixi-vn-live2d/core/interfaces/Live2DModelEvents#hit)

#### Inherited from [#inherited-from-192]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`tap`](/pixi-vn-live2d/core/classes/Live2DModel#tap)

***

### toGlobal() [#toglobal]

\> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-18]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-84]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-130]

`P`

The global position

#### Example [#example-113]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-42]

* [Container#toLocal](/pixi-vn-live2d/core/classes/Live2DModel#tolocal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn-live2d/core/classes/Live2DModel#getglobalposition) For container position

#### Inherited from [#inherited-from-193]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`toGlobal`](/pixi-vn-live2d/core/classes/Live2DModel#toglobal)

***

### toLocal() [#tolocal]

\> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-19]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-85]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-131]

`P`

A point object representing the position in local space

#### Example [#example-114]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-43]

* [Container#toGlobal](/pixi-vn-live2d/core/classes/Live2DModel#toglobal) For reverse conversion
* [Container#getGlobalPosition](/pixi-vn-live2d/core/classes/Live2DModel#getglobalposition) For container position

#### Inherited from [#inherited-from-194]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`toLocal`](/pixi-vn-live2d/core/classes/Live2DModel#tolocal)

***

### toModelPosition() [#tomodelposition]

\> **toModelPosition**(`position`, `result?`, `skipUpdate?`): `Point`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4607

Calculates the position in the canvas of original, unscaled Live2D model.

#### Parameters [#parameters-86]

##### position [#position-3]

`Point`

A Point in world space.

##### result? [#result]

`Point`

A Point to store the new value. Defaults to a new Point.

##### skipUpdate? [#skipupdate-7]

`boolean`

True to skip the update transform.

#### Returns [#returns-132]

`Point`

The Point in model canvas space.

#### Inherited from [#inherited-from-195]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`toModelPosition`](/pixi-vn-live2d/core/classes/Live2DModel#tomodelposition)

***

### update() [#update]

\> **update**(`dt`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4623

Updates the model. Note this method just updates the timer,
and the actual update will be done right before rendering the model.

#### Parameters [#parameters-87]

##### dt [#dt]

`number`

The elapsed time in milliseconds since last frame.

#### Returns [#returns-133]

`void`

#### Inherited from [#inherited-from-196]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`update`](/pixi-vn-live2d/core/classes/Live2DModel#update)

***

### updateLocalTransform() [#updatelocaltransform]

\> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-134]

`void`

#### Inherited from [#inherited-from-197]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`updateLocalTransform`](/pixi-vn-live2d/core/classes/Live2DModel#updatelocaltransform)

***

### updateTransform() [#updatetransform]

\> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-88]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-135]

`this`

This container, for chaining

#### Example [#example-115]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-44]

* Container#setFromMatrix For matrix-based transforms
* [Container#position](/pixi-vn-live2d/core/classes/Live2DModel#position) For direct position access

#### Inherited from [#inherited-from-198]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`updateTransform`](/pixi-vn-live2d/core/classes/Live2DModel#updatetransform)

***

### create() [#create]

\> `static` **create**(`options`): `Promise`\<`Live2D`>

Defined in: [src/components/Live2D.ts:162](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/components/Live2D.ts#L162)

Creates a Live2D instance and waits until its resources have been loaded.

#### Parameters [#parameters-89]

##### options [#options-9]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions)

The options for the component.

#### Returns [#returns-136]

`Promise`\<`Live2D`>

***

### from() [#from-1]

\> `static` **from**\<`M`>(`this`, `source`, `options?`): `Promise`\<`InstanceType`\<`M`>>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4365

Creates a Live2DModel from given source.

#### Type Parameters [#type-parameters-20]

##### M [#m]

`M` *extends* [`Live2DConstructor`](/pixi-vn-live2d/core/type-aliases/Live2DConstructor) = *typeof* [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)

#### Parameters [#parameters-90]

##### this [#this]

`M`

##### source [#source]

`string` | `object` | [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Can be one of: settings file URL, settings JSON object, ModelSettings instance.

##### options? [#options-10]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options for the creation.

#### Returns [#returns-137]

`Promise`\<`InstanceType`\<`M`>>

Promise that resolves with the Live2DModel.

#### Inherited from [#inherited-from-199]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`from`](/pixi-vn-live2d/core/classes/Live2DModel#from)

***

### fromSync() [#fromsync]

\> `static` **fromSync**\<`M`>(`this`, `source`, `options?`): `InstanceType`\<`M`>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4389

Synchronous version of `Live2DModel.from()`. This method immediately returns a Live2DModel instance,
whose resources have not been loaded. Therefore, this model can't be manipulated or rendered
until the "load" event has been emitted.

```js
// no `await` here as it's not a Promise
const model = Live2DModel.fromSync('shizuku.model.json');

// these will cause errors!
// app.stage.addChild(model);
// model.motion('tap_body');

model.once('load', () => {
    // now it's safe
    app.stage.addChild(model);
    model.motion('tap_body');
});
```

#### Type Parameters [#type-parameters-21]

##### M [#m-1]

`M` *extends* [`Live2DConstructor`](/pixi-vn-live2d/core/type-aliases/Live2DConstructor) = *typeof* [`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel)

#### Parameters [#parameters-91]

##### this [#this-1]

`M`

##### source [#source-1]

`string` | `object` | [`ModelSettings`](/pixi-vn-live2d/core/classes/ModelSettings)

Model source, can be a file path, JSON object, or ModelSettings instance.

##### options? [#options-11]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)

Options for the model creation.

#### Returns [#returns-138]

`InstanceType`\<`M`>

The created Live2DModel instance.

#### Inherited from [#inherited-from-200]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`fromSync`](/pixi-vn-live2d/core/classes/Live2DModel#fromsync)

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-92]

##### source [#source-2]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-139]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

#### Inherited from [#inherited-from-201]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`mixin`](/pixi-vn-live2d/core/classes/Live2DModel#mixin)

***

### ~~registerTicker()~~ [#registerticker]

\> `static` **registerTicker**(`tickerClass`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4395

Registers the class of `PIXI.Ticker` for auto updating.

#### Parameters [#parameters-93]

##### tickerClass [#tickerclass]

*typeof* `Ticker`

The Ticker class to be registered.

#### Returns [#returns-140]

`void`

#### Deprecated [#deprecated-4]

Use [Live2DModelOptions.ticker](/pixi-vn-live2d/core/interfaces/AutomatorOptions#ticker) instead.

#### Inherited from [#inherited-from-202]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`registerTicker`](/pixi-vn-live2d/core/classes/Live2DModel#registerticker)


# index (/pixi-vn-live2d/index)



## Classes [#classes]

* [Live2D](/pixi-vn-live2d/index/classes/Live2D)

## Interfaces [#interfaces]

* [Live2DMemory](/pixi-vn-live2d/index/interfaces/Live2DMemory)
* [Live2DOptions](/pixi-vn-live2d/index/interfaces/Live2DOptions)
* [MotionMemory](/pixi-vn-live2d/index/interfaces/MotionMemory)


# Interface: Live2DMemory (/pixi-vn-live2d/index/interfaces/Live2DMemory)



Defined in: [src/interfaces/Live2DMemory.ts:59](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L59)

## Extends [#extends]

* `MemoryCore`.`CanvasBaseItemMemory`.`ListenerExtensionMemory`.`AdditionalPositionsExtensionProps`

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`MemoryCore.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`MemoryCore.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`MemoryCore.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`MemoryCore.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`MemoryCore.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`MemoryCore.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`MemoryCore.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`align`](/pixi-vn-live2d/index/interfaces/Live2DOptions#align)

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`MemoryCore.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `object`

Defined in: [src/interfaces/Live2DMemory.ts:68](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L68)

#### x [#x]

\> **x**: `number`

#### y [#y]

\> **y**: `number`

#### Overrides [#overrides]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`anchor`](/pixi-vn-live2d/index/interfaces/Live2DOptions#anchor)

***

### anchorMode? [#anchormode]

\> `optional` **anchorMode?**: `"canvas"` | `"drawable"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4293

Defines which bounds are used to resolve the normalized [Live2DModel.anchor](/pixi-vn-live2d/core/classes/Live2DModel#anchor).
`'canvas'` preserves the historical model-canvas behavior, while `'drawable'`
resolves the anchor against the visible drawable bounds.

#### Default [#default-8]

```ts
'canvas'
```

#### Inherited from [#inherited-from-9]

[`Live2DModelOptions`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`anchorMode`](/pixi-vn-live2d/core/interfaces/Live2DModelOptions#anchormode)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`MemoryCore.angle`

***

### autoFocus? [#autofocus]

\> `optional` **autoFocus?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when `globalpointermove` event is triggered.

#### Default [#default-9]

```ts
true
```

#### Inherited from [#inherited-from-11]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoFocus`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autofocus)

***

### autoHitTest? [#autohittest]

\> `optional` **autoHitTest?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when `pointertap` event is triggered.

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-12]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoHitTest`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autohittest)

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` **autoInteract?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

#### Default [#default-11]

```ts
true
```

#### Deprecated [#deprecated]

since v0.5.0, reading/writing this property is equivalent to reading/writing `autoHitTest && autoFocus`.

#### Inherited from [#inherited-from-13]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoInteract`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autointeract)

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by `PIXI.Ticker.shared`.

#### Default [#default-12]

```ts
ture
```

#### Inherited from [#inherited-from-14]

[`AutomatorOptions`](/pixi-vn-live2d/core/interfaces/AutomatorOptions).[`autoUpdate`](/pixi-vn-live2d/core/interfaces/AutomatorOptions#autoupdate)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-13]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-15]

`MemoryCore.blendMode`

***

### breathDepth? [#breathdepth]

\> `optional` **breathDepth?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default-14]

```ts
1.0
```

#### Inherited from [#inherited-from-16]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`breathDepth`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#breathdepth)

***

### checkMocConsistency? [#checkmocconsistency]

\> `optional` **checkMocConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4051

Whether to check the consistency of the moc file. It's an internal
function of Cubism core and only available since Cubism 4 R7.

#### Default [#default-15]

```ts
false
```

#### Inherited from [#inherited-from-17]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`checkMocConsistency`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#checkmocconsistency)

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4071

Whether to validate motion3.json consistency when loading motions.

#### Default [#default-16]

```ts
false
```

#### Inherited from [#inherited-from-18]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`checkMotionConsistency`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#checkmotionconsistency)

***

### crossOrigin? [#crossorigin]

\> `optional` **crossOrigin?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4056

String to use for crossOrigin properties on `<img>` elements when loading textures.

#### Default [#default-17]

```ts
undefined
```

#### Inherited from [#inherited-from-19]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`crossOrigin`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#crossorigin)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-10]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-18]

```ts
false
```

#### Inherited from [#inherited-from-20]

`MemoryCore.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-11]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-19]

```ts
true
```

#### Inherited from [#inherited-from-21]

`MemoryCore.cullableChildren`

***

### currentExpressionId? [#currentexpressionid]

\> `optional` **currentExpressionId?**: `string` | `number`

Defined in: [src/interfaces/Live2DMemory.ts:84](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L84)

The id (index or name) of the expression currently applied to the model.

***

### currentMotion? [#currentmotion]

\> `optional` **currentMotion?**: [`MotionMemory`](/pixi-vn-live2d/index/interfaces/MotionMemory)

Defined in: [src/interfaces/Live2DMemory.ts:76](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L76)

The motion currently playing on the main motion manager.

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-12]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-20]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-22]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cursor`](/pixi-vn-live2d/core/classes/Live2DModel#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-23]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`eventMode`](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-21]

```ts
true
```

#### Inherited from [#inherited-from-24]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`eyeBlink`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#eyeblink)

***

### focus? [#focus]

\> `optional` **focus?**: `object`

Defined in: [src/interfaces/Live2DMemory.ts:72](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L72)

The focus position of the model, in world space.

#### x [#x-1]

\> **x**: `number`

#### y [#y-1]

\> **y**: `number`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-14]

```ts
new Container({ height: 100});
```

#### Default [#default-22]

```ts
0
```

#### Inherited from [#inherited-from-25]

`MemoryCore.height`

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-23]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

#### Inherited from [#inherited-from-26]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions).[`idleMotionGroup`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions#idlemotiongroup)

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:169

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-27]

`CanvasBaseItemMemory.index`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-3]

[Container.eventMode](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

#### Example [#example-15]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-28]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactive`](/pixi-vn-live2d/core/classes/Live2DModel#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-24]

```ts
true
```

#### Example [#example-16]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-29]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactiveChildren`](/pixi-vn-live2d/core/classes/Live2DModel#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-4]

Container#isRenderGroup

#### Inherited from [#inherited-from-30]

`MemoryCore.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-31]

`MemoryCore.label`

***

### lipSyncGain? [#lipsyncgain]

\> `optional` **lipSyncGain?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

#### Default [#default-26]

```ts
1.5
```

#### Inherited from [#inherited-from-32]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`lipSyncGain`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#lipsyncgain)

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` **lipSyncWeight?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

#### Default [#default-27]

```ts
0.4
```

#### Inherited from [#inherited-from-33]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`lipSyncWeight`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#lipsyncweight)

***

### motionPreload? [#motionpreload]

\> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-28]

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from [#inherited-from-34]

[`MotionManagerOptions`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions).[`motionPreload`](/pixi-vn-live2d/core/interfaces/MotionManagerOptions#motionpreload)

***

### onEvents? [#onevents]

\> `optional` **onEvents?**: `OnEventsHandlers`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:344

#### Inherited from [#inherited-from-35]

`ListenerExtensionMemory.onEvents`

***

### origin? [#origin]

\> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-17]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-36]

`MemoryCore.origin`

***

### parallelMotions [#parallelmotions]

\> **parallelMotions**: ([`MotionMemory`](/pixi-vn-live2d/index/interfaces/MotionMemory) | `null`)\[]

Defined in: [src/interfaces/Live2DMemory.ts:80](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L80)

The motions currently playing on each parallel motion manager.

***

### parentLabel? [#parentlabel]

\> `optional` **parentLabel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:173

The label of the parent container, if it has one

#### Inherited from [#inherited-from-37]

`CanvasBaseItemMemory.parentLabel`

***

### percentagePosition? [#percentageposition]

\> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-38]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`percentagePosition`](/pixi-vn-live2d/index/interfaces/Live2DOptions#percentageposition)

***

### percentageX? [#percentagex]

\> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-39]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`percentageX`](/pixi-vn-live2d/index/interfaces/Live2DOptions#percentagex)

***

### percentageY? [#percentagey]

\> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-40]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`percentageY`](/pixi-vn-live2d/index/interfaces/Live2DOptions#percentagey)

***

### pivot? [#pivot]

\> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-18]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-41]

`MemoryCore.pivot`

***

### pixivnId [#pixivnid]

\> **pixivnId**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:165

#### Inherited from [#inherited-from-42]

`CanvasBaseItemMemory.pixivnId`

***

### position? [#position]

\> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-19]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-43]

`MemoryCore.position`

***

### renderable? [#renderable]

\> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-20]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-29]

```ts
true
```

#### See [#see-5]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-44]

`MemoryCore.renderable`

***

### rotation? [#rotation]

\> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-21]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-45]

`MemoryCore.rotation`

***

### scale? [#scale]

\> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-22]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-46]

`MemoryCore.scale`

***

### setMask? [#setmask]

\> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-47]

`MemoryCore.setMask`

***

### skew? [#skew]

\> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-23]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-30]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-48]

`MemoryCore.skew`

***

### sortableChildren? [#sortablechildren]

\> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-24]

```ts
container.sortableChildren = true;
```

#### Default [#default-31]

```ts
false
```

#### Inherited from [#inherited-from-49]

`MemoryCore.sortableChildren`

***

### sortDirty? [#sortdirty]

\> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-32]

```ts
false
@internal
```

#### Inherited from [#inherited-from-50]

`MemoryCore.sortDirty`

***

### source [#source]

\> **source**: `string`

Defined in: [src/interfaces/Live2DMemory.ts:67](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DMemory.ts#L67)

The model source. Must be a URL/alias string so it can be reloaded when the memory is restored.

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-33]

```ts
0
```

#### Example [#example-25]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-51]

`MemoryCore.tabIndex`

***

### textureOptions? [#textureoptions]

\> `optional` **textureOptions?**: [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4079

Texture loading and atlas LOD options.

See [Live2DTextureLODOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions) for the available `lod` strategies.

#### Default [#default-34]

```ts
{ lod: 'full' }
```

#### Inherited from [#inherited-from-52]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`textureOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#textureoptions)

***

### tint? [#tint]

\> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-26]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-35]

```ts
0xFFFFFF
```

#### See [#see-6]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-53]

`MemoryCore.tint`

***

### useHighPrecisionMask? [#usehighprecisionmask]

\> `optional` **useHighPrecisionMask?**: `boolean` | `"auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering.
Only supported by Cubism 3/4/5 models.

#### Default [#default-36]

```ts
'auto'
```

#### Inherited from [#inherited-from-54]

[`InternalModelOptions`](/pixi-vn-live2d/core/interfaces/InternalModelOptions).[`useHighPrecisionMask`](/pixi-vn-live2d/core/interfaces/InternalModelOptions#usehighprecisionmask)

***

### visible? [#visible]

\> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-27]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-37]

```ts
true
```

#### See [#see-7]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-55]

`MemoryCore.visible`

***

### width? [#width]

\> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-28]

```ts
new Container({ width: 100});
```

#### Default [#default-38]

```ts
0
```

#### Inherited from [#inherited-from-56]

`MemoryCore.width`

***

### x? [#x-2]

\> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-29]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-57]

`MemoryCore.x`

***

### xAlign? [#xalign]

\> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-58]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`xAlign`](/pixi-vn-live2d/index/interfaces/Live2DOptions#xalign)

***

### y? [#y-2]

\> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-30]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-59]

`MemoryCore.y`

***

### yAlign? [#yalign]

\> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-60]

[`Live2DOptions`](/pixi-vn-live2d/index/interfaces/Live2DOptions).[`yAlign`](/pixi-vn-live2d/index/interfaces/Live2DOptions#yalign)

***

### zIndex? [#zindex]

\> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-31]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-8]

* [Container#sortableChildren](/pixi-vn-live2d/core/classes/Live2DModel#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-39]

```ts
0
```

#### Inherited from [#inherited-from-61]

`MemoryCore.zIndex`


# Interface: Live2DOptions (/pixi-vn-live2d/index/interfaces/Live2DOptions)



Defined in: [src/interfaces/Live2DOptions.ts:4](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DOptions.ts#L4)

## Extends [#extends]

* [`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).`ContainerOptions`

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`ContainerOptions.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`ContainerOptions.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`ContainerOptions.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`ContainerOptions.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`ContainerOptions.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`ContainerOptions.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`ContainerOptions.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:219

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`ContainerOptions.align`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`ContainerOptions.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:919

#### Inherited from [#inherited-from-9]

`ContainerOptions.anchor`

***

### anchorMode? [#anchormode]

\> `optional` **anchorMode?**: `"canvas"` | `"drawable"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4293

Defines which bounds are used to resolve the normalized [Live2DModel.anchor](/pixi-vn-live2d/core/classes/Live2DModel#anchor).
`'canvas'` preserves the historical model-canvas behavior, while `'drawable'`
resolves the anchor against the visible drawable bounds.

#### Default [#default-8]

```ts
'canvas'
```

#### Inherited from [#inherited-from-10]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`anchorMode`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#anchormode)

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-8]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-11]

`ContainerOptions.angle`

***

### autoFocus? [#autofocus]

\> `optional` **autoFocus?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when `globalpointermove` event is triggered.

#### Default [#default-9]

```ts
true
```

#### Inherited from [#inherited-from-12]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`autoFocus`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#autofocus)

***

### autoHitTest? [#autohittest]

\> `optional` **autoHitTest?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when `pointertap` event is triggered.

#### Default [#default-10]

```ts
true
```

#### Inherited from [#inherited-from-13]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`autoHitTest`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#autohittest)

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` **autoInteract?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

#### Default [#default-11]

```ts
true
```

#### Deprecated [#deprecated]

since v0.5.0, reading/writing this property is equivalent to reading/writing `autoHitTest && autoFocus`.

#### Inherited from [#inherited-from-14]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`autoInteract`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#autointeract)

***

### autoUpdate? [#autoupdate]

\> `optional` **autoUpdate?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by `PIXI.Ticker.shared`.

#### Default [#default-12]

```ts
ture
```

#### Inherited from [#inherited-from-15]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`autoUpdate`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#autoupdate)

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-9]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-13]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-16]

`ContainerOptions.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-10]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-17]

`ContainerOptions.boundsArea`

***

### breathDepth? [#breathdepth]

\> `optional` **breathDepth?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default-14]

```ts
1.0
```

#### Inherited from [#inherited-from-18]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`breathDepth`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#breathdepth)

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-19]

`ContainerOptions.cacheAsTexture`

***

### checkMocConsistency? [#checkmocconsistency]

\> `optional` **checkMocConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4051

Whether to check the consistency of the moc file. It's an internal
function of Cubism core and only available since Cubism 4 R7.

#### Default [#default-15]

```ts
false
```

#### Inherited from [#inherited-from-20]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`checkMocConsistency`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#checkmocconsistency)

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` **checkMotionConsistency?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4071

Whether to validate motion3.json consistency when loading motions.

#### Default [#default-16]

```ts
false
```

#### Inherited from [#inherited-from-21]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`checkMotionConsistency`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#checkmotionconsistency)

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-11]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-22]

`ContainerOptions.children`

***

### crossOrigin? [#crossorigin]

\> `optional` **crossOrigin?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4056

String to use for crossOrigin properties on `<img>` elements when loading textures.

#### Default [#default-17]

```ts
undefined
```

#### Inherited from [#inherited-from-23]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`crossOrigin`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#crossorigin)

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-12]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-18]

```ts
false
```

#### Inherited from [#inherited-from-24]

`ContainerOptions.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-13]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-19]

```ts
true
```

#### Inherited from [#inherited-from-25]

`ContainerOptions.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-14]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-26]

`ContainerOptions.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `Cursor` | `string` & `object`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-15]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-21]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-27]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`cursor`](/pixi-vn-live2d/core/classes/Live2DModel#cursor)

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-28]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`eventMode`](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

***

### eyeBlink? [#eyeblink]

\> `optional` **eyeBlink?**: `boolean`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-22]

```ts
true
```

#### Inherited from [#inherited-from-29]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`eyeBlink`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#eyeblink)

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-17]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-30]

`ContainerOptions.filters`

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-18]

```ts
new Container({ height: 100});
```

#### Default [#default-23]

```ts
0
```

#### Inherited from [#inherited-from-31]

`ContainerOptions.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-19]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-32]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`hitArea`](/pixi-vn-live2d/core/classes/Live2DModel#hitarea)

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` **idleMotionGroup?**: `string`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-24]

```ts
"idle" in Cubism 2 and "Idle" in Cubism 4.
```

#### Inherited from [#inherited-from-33]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`idleMotionGroup`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#idlemotiongroup)

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-live2d/core/classes/Live2DModel#eventmode)

#### Example [#example-20]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-34]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactive`](/pixi-vn-live2d/core/classes/Live2DModel#interactive)

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-25]

```ts
true
```

#### Example [#example-21]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-35]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`interactiveChildren`](/pixi-vn-live2d/core/classes/Live2DModel#interactivechildren)

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-36]

`ContainerOptions.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-37]

`ContainerOptions.label`

***

### lipSyncGain? [#lipsyncgain]

\> `optional` **lipSyncGain?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

#### Default [#default-27]

```ts
1.5
```

#### Inherited from [#inherited-from-38]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`lipSyncGain`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#lipsyncgain)

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` **lipSyncWeight?**: `number`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

#### Default [#default-28]

```ts
0.4
```

#### Inherited from [#inherited-from-39]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`lipSyncWeight`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#lipsyncweight)

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-22]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`ContainerOptions.mask`

***

### motionPreload?

> `optional` **motionPreload?**: [`MotionPreloadStrategy`](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default

[MotionPreloadStrategy.NONE](/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`motionPreload`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#motionpreload)

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-40]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onclick`](/pixi-vn-live2d/core/classes/Live2DModel#onclick)

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-23]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-30]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-41]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobalmousemove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobalmousemove)

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-42]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobalpointermove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobalpointermove)

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-32]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-43]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onglobaltouchmove`](/pixi-vn-live2d/core/classes/Live2DModel#onglobaltouchmove)

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-44]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmousedown`](/pixi-vn-live2d/core/classes/Live2DModel#onmousedown)

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-45]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseenter`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseenter)

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-46]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseleave`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseleave)

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-47]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmousemove`](/pixi-vn-live2d/core/classes/Live2DModel#onmousemove)

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-48]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseout`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseout)

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-49]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseover`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseover)

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-50]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseup`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseup)

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-51]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onmouseupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onmouseupoutside)

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-52]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointercancel`](/pixi-vn-live2d/core/classes/Live2DModel#onpointercancel)

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-53]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerdown`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerdown)

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-54]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerenter`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerenter)

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-55]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerleave`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerleave)

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointermove`](/pixi-vn-live2d/core/classes/Live2DModel#onpointermove)

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-57]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerout`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerout)

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-58]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerover`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerover)

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-59]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointertap`](/pixi-vn-live2d/core/classes/Live2DModel#onpointertap)

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-60]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerup`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerup)

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-50]

```ts
null
```

#### Inherited from [#inherited-from-61]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onpointerupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onpointerupoutside)

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-44]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-62]

`ContainerOptions.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-51]

```ts
null
```

#### Inherited from [#inherited-from-63]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightclick`](/pixi-vn-live2d/core/classes/Live2DModel#onrightclick)

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-52]

```ts
null
```

#### Inherited from [#inherited-from-64]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightdown`](/pixi-vn-live2d/core/classes/Live2DModel#onrightdown)

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-53]

```ts
null
```

#### Inherited from [#inherited-from-65]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightup`](/pixi-vn-live2d/core/classes/Live2DModel#onrightup)

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-54]

```ts
null
```

#### Inherited from [#inherited-from-66]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onrightupoutside`](/pixi-vn-live2d/core/classes/Live2DModel#onrightupoutside)

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-55]

```ts
null
```

#### Inherited from [#inherited-from-67]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontap`](/pixi-vn-live2d/core/classes/Live2DModel#ontap)

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-56]

```ts
null
```

#### Inherited from [#inherited-from-68]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchcancel`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchcancel)

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-57]

```ts
null
```

#### Inherited from [#inherited-from-69]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchend`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchend)

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-58]

```ts
null
```

#### Inherited from [#inherited-from-70]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchendoutside`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchendoutside)

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-59]

```ts
null
```

#### Inherited from [#inherited-from-71]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchmove`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchmove)

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-60]

```ts
null
```

#### Inherited from [#inherited-from-72]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`ontouchstart`](/pixi-vn-live2d/core/classes/Live2DModel#ontouchstart)

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-61]

```ts
null
```

#### Inherited from [#inherited-from-73]

[`Live2DModel`](/pixi-vn-live2d/core/classes/Live2DModel).[`onwheel`](/pixi-vn-live2d/core/classes/Live2DModel#onwheel)

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-56]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-74]

`ContainerOptions.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-75]

`ContainerOptions.parent`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:249

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-76]

`ContainerOptions.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:259

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-77]

`ContainerOptions.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:269

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-78]

`ContainerOptions.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-57]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-79]

`ContainerOptions.pivot`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-58]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-80]

`ContainerOptions.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-59]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-62]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-81]

`ContainerOptions.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-60]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-82]

`ContainerOptions.rotation`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-61]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-83]

`ContainerOptions.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-84]

`ContainerOptions.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-62]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-63]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-85]

`ContainerOptions.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-63]

```ts
container.sortableChildren = true;
```

#### Default [#default-64]

```ts
false
```

#### Inherited from [#inherited-from-86]

`ContainerOptions.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-65]

```ts
false
@internal
```

#### Inherited from [#inherited-from-87]

`ContainerOptions.sortDirty`

***

### source [#source]

> **source**: `string`

Defined in: [src/interfaces/Live2DOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/Live2DOptions.ts#L11)

The model settings file URL (e.g. `model.model3.json` or `model.model.json`), or an
alias registered with Pixi's `Assets` (e.g. via `Assets.add({ alias, src })`). If
`source` matches a registered alias, it is resolved through `Assets`; otherwise it's
treated as a direct URL.

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-66]

```ts
0
```

#### Example [#example-64]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-88]

`ContainerOptions.tabIndex`

***

### textureOptions? [#textureoptions]

> `optional` **textureOptions?**: [`Live2DTextureSourceOptions`](/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4079

Texture loading and atlas LOD options.

See [Live2DTextureLODOptions](/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions) for the available `lod` strategies.

#### Default [#default-67]

```ts
{ lod: 'full' }
```

#### Inherited from [#inherited-from-89]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`textureOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#textureoptions)

***

### ticker? [#ticker]

> `optional` **ticker?**: `Ticker`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

#### Default [#default-68]

`PIXI.Ticker.shared` from the global PIXI namespace.

#### Inherited from [#inherited-from-90]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`ticker`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#ticker)

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-65]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-69]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-91]

`ContainerOptions.tint`

***

### useHighPrecisionMask? [#usehighprecisionmask]

> `optional` **useHighPrecisionMask?**: `boolean` | `"auto"`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering.
Only supported by Cubism 3/4/5 models.

#### Default [#default-70]

```ts
'auto'
```

#### Inherited from [#inherited-from-92]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`useHighPrecisionMask`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#usehighprecisionmask)

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-66]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-71]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-93]

`ContainerOptions.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-67]

```ts
new Container({ width: 100});
```

#### Default [#default-72]

```ts
0
```

#### Inherited from [#inherited-from-94]

`ContainerOptions.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-68]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-95]

`ContainerOptions.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:229

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-96]

`ContainerOptions.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-69]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-97]

`ContainerOptions.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-BpDgacyr.d.ts:239

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-98]

`ContainerOptions.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-70]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-live2d/core/classes/Live2DModel#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-73]

```ts
0
```

#### Inherited from [#inherited-from-99]

`ContainerOptions.zIndex`

## Methods [#methods]

### onError()? [#onerror]

> `optional` **onError**(`e`): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4066

Callback invoked when error occurs while loading the model.

#### Parameters [#parameters-2]

##### e [#e]

`Error`

#### Returns [#returns-2]

`void`

#### Default [#default-74]

```ts
undefined
```

#### Inherited from [#inherited-from-100]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`onError`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#onerror)

***

### onLoad()? [#onload]

> `optional` **onLoad**(): `void`

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4061

Callback invoked when the model has been loaded.

#### Returns [#returns-3]

`void`

#### Default [#default-75]

```ts
undefined
```

#### Inherited from [#inherited-from-101]

[`Live2DFactoryOptions`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions).[`onLoad`](/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions#onload)


# Interface: MotionMemory (/pixi-vn-live2d/index/interfaces/MotionMemory)



Defined in: [src/interfaces/MotionMemory.ts:3](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/MotionMemory.ts#L3)

## Properties [#properties]

### group [#group]

\> **group**: `string`

Defined in: [src/interfaces/MotionMemory.ts:7](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/MotionMemory.ts#L7)

The motion group.

***

### index [#index]

\> **index**: `number`

Defined in: [src/interfaces/MotionMemory.ts:11](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/MotionMemory.ts#L11)

The index of the motion in its group.

***

### priority [#priority]

\> **priority**: [`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

Defined in: [src/interfaces/MotionMemory.ts:15](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/interfaces/MotionMemory.ts#L15)

The priority the motion was started with.


# Function: createLive2DHandler() (/pixi-vn-live2d/ink/functions/createLive2DHandler)



\> **createLive2DHandler**(): `void`

Defined in: [src/ink/live2dHandler.ts:196](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/ink/live2dHandler.ts#L196)

Registers the `# show live2d` Ink hashtag command, letting Ink scripts show a [Live2D](/pixi-vn-live2d/index/classes/Live2D)
canvas element the same way `@drincs/pixi-vn-ink`'s built-in `# show image` shows an
`ImageSprite`: `<alias>` is just the canvas key (like every other `# show ...` command).
`<source>` (the model settings URL, or an asset alias) is an optional second positional token —
when omitted, `<alias>` itself is used as the source. Key/value construction props (forwarded to
[Live2DOptions](/pixi-vn-live2d/index/interfaces/Live2DOptions)) and an optional entrance transition follow.

Registered as two handlers (one per position of the free-form props, since `keySchemas` keys
refer to a fixed token index) that together behave as a single command with an optional
`<source>`.

Call this once, near the start of your app (alongside e.g. `addBaseHashtagCommands`), before any
Ink content is parsed.

## Returns [#returns]

`void`

## Example [#example]

```ink
# show live2d hero xAlign 0.5 yAlign 1 with dissolve duration 1
# show live2d hero hero-alt xAlign 0.5 yAlign 1 with dissolve duration 1
```


# Function: parseShowLive2DTail() (/pixi-vn-live2d/ink/functions/parseShowLive2DTail)



\> **parseShowLive2DTail**(`tail`): `object`

Defined in: [src/ink/live2dHandler.ts:105](https://github.com/DRincs-Productions/pixi-vn-live2d/blob/a27c995126daea5e584456a2e047e03c6c32d562/src/ink/live2dHandler.ts#L105)

Splits the tail (everything after `<alias>`) of a `# show live2d` command into its free-form
construction props and an optional entrance transition.

## Parameters [#parameters]

### tail [#tail]

`string`\[]

## Returns [#returns]

`object`

### propsList [#propslist]

\> **propsList**: `string`\[]

### transitionPropsList [#transitionpropslist]

\> **transitionPropsList**: `string`\[]

### transitionType? [#transitiontype]

\> `optional` **transitionType?**: `"dissolve"` | `"fade"` | `"movein"` | `"zoomin"` | `"pushin"`


# ink (/pixi-vn-live2d/ink)



## Functions [#functions]

* [createLive2DHandler](/pixi-vn-live2d/ink/functions/createLive2DHandler)
* [parseShowLive2DTail](/pixi-vn-live2d/ink/functions/parseShowLive2DTail)


# @drincs/pixi-vn-live2d (/pixi-vn-live2d/modules)



## Modules [#modules]

* [core](/pixi-vn-live2d/core)
* [index](/pixi-vn-live2d/index)
* [ink](/pixi-vn-live2d/ink)


# Class: ComfyUIImageModel (/pixi-vn-ai/comfyui/classes/ComfyUIImageModel)



Defined in: [src/comfyui/ComfyUIImageModel.ts:55](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L55)

An [AI SDK](https://ai-sdk.dev) `ImageModelV2` backed by a self-hosted
[ComfyUI](https://github.com/comfyanonymous/ComfyUI) server, so it can be passed directly as
`ai.init({ imageProvider: new ComfyUIImageModel({ ... }) })`.

Since ComfyUI runs arbitrary node graphs rather than accepting a plain prompt, this model only
injects the developer request into the workflow node/input given by [ComfyUIImageModelOptions.promptNodeId](/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions#promptnodeid)/[ComfyUIImageModelOptions.promptInputName](/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions#promptinputname): every
other parameter (checkpoint, sampler, seed, size, ...) is whatever the given workflow specifies.

## Implements [#implements]

* `ImageModelV2`

## Constructors [#constructors]

### Constructor [#constructor]

\> **new ComfyUIImageModel**(`options`): `ComfyUIImageModel`

Defined in: [src/comfyui/ComfyUIImageModel.ts:63](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L63)

#### Parameters [#parameters]

##### options [#options]

[`ComfyUIImageModelOptions`](/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions)

#### Returns [#returns]

`ComfyUIImageModel`

## Properties [#properties]

### maxImagesPerCall [#maximagespercall]

\> `readonly` **maxImagesPerCall**: `1` = `1`

Defined in: [src/comfyui/ComfyUIImageModel.ts:59](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L59)

Limit of how many images can be generated in a single API call.
Can be set to a number for a fixed limit, to undefined to use
the global limit, or a function that returns a number or undefined,
optionally as a promise.

#### Implementation of [#implementation-of]

`ImageModelV2.maxImagesPerCall`

***

### modelId [#modelid]

\> `readonly` **modelId**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:58](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L58)

Provider-specific model ID for logging purposes.

#### Implementation of [#implementation-of-1]

`ImageModelV2.modelId`

***

### provider [#provider]

\> `readonly` **provider**: `"comfyui"` = `"comfyui"`

Defined in: [src/comfyui/ComfyUIImageModel.ts:57](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L57)

Name of the provider for logging purposes.

#### Implementation of [#implementation-of-2]

`ImageModelV2.provider`

***

### specificationVersion [#specificationversion]

\> `readonly` **specificationVersion**: `"v2"`

Defined in: [src/comfyui/ComfyUIImageModel.ts:56](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L56)

The image model must specify which image model interface
version it implements. This will allow us to evolve the image
model interface and retain backwards compatibility. The different
implementation versions can be handled as a discriminated union
on our side.

#### Implementation of [#implementation-of-3]

`ImageModelV2.specificationVersion`

## Methods [#methods]

### doGenerate() [#dogenerate]

\> **doGenerate**(`callOptions`): `Promise`\<\{ `images`: `string`\[]; `response`: \{ `headers`: `undefined`; `modelId`: `string`; `timestamp`: `Date`; }; `warnings`: `never`\[]; }>

Defined in: [src/comfyui/ComfyUIImageModel.ts:68](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L68)

Generates an array of images.

#### Parameters [#parameters-1]

##### callOptions [#calloptions]

`ImageModelV2CallOptions`

#### Returns [#returns-1]

`Promise`\<\{ `images`: `string`\[]; `response`: \{ `headers`: `undefined`; `modelId`: `string`; `timestamp`: `Date`; }; `warnings`: `never`\[]; }>

#### Implementation of [#implementation-of-4]

`ImageModelV2.doGenerate`


# comfyui (/pixi-vn-ai/comfyui)



## Classes [#classes]

* [ComfyUIImageModel](/pixi-vn-ai/comfyui/classes/ComfyUIImageModel)

## Interfaces [#interfaces]

* [ComfyUIImageModelOptions](/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions)


# Interface: ComfyUIImageModelOptions (/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions)



Defined in: [src/comfyui/ComfyUIImageModel.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L11)

## Properties [#properties]

### apiHost [#apihost]

\> **apiHost**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L15)

The ComfyUI server address, e.g. `"127.0.0.1:8188"` or `"my-comfyui.example.com"`.

***

### promptInputName? [#promptinputname]

\> `optional` **promptInputName?**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:37](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L37)

The name of the input on [promptNodeId](#promptnodeid) that holds the prompt text.

#### Default [#default]

```ts
"text"
```

***

### promptNodeId [#promptnodeid]

\> **promptNodeId**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:32](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L32)

The ID of the node (as it appears in [workflow](#workflow)) whose input holds the positive
prompt text (typically a `CLIPTextEncode` node).

***

### ssl? [#ssl]

\> `optional` **ssl?**: `boolean`

Defined in: [src/comfyui/ComfyUIImageModel.ts:20](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L20)

Whether to connect over SSL/WSS.

#### Default [#default-1]

```ts
false
```

***

### timeoutMs? [#timeoutms]

\> `optional` **timeoutMs?**: `number`

Defined in: [src/comfyui/ComfyUIImageModel.ts:42](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L42)

Milliseconds to wait for the workflow to finish before giving up.

#### Default [#default-2]

```ts
300000 (5 minutes)
```

***

### workflow [#workflow]

\> **workflow**: `Record`\<`string`, `unknown`>

Defined in: [src/comfyui/ComfyUIImageModel.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L27)

The ComfyUI workflow to run, exported in **API format** (ComfyUI menu: "Save (API Format)").
Pixi'VN AI has no way to know how your workflow is structured (checkpoint, sampler, custom
nodes, ...), so you provide it, along with where to inject the prompt via
[promptNodeId](#promptnodeid)/[promptInputName](#promptinputname).


# @drincs/pixi-vn-ai (/pixi-vn-ai)



AI-powered dialogue and image generation for [Pixi'VN](https://pixi-vn.com) visual novels.

This library is **not** a low-level LLM client. It's a small, high-level abstraction with three
functions — `ai.text.generateDialog`, `ai.image.generateBackground`, `ai.image.generateElement` —
that hide all prompt engineering: you pass a natural-language request plus a few structured
options (scene, style, speaker, alignment, ...), and the library assembles the actual prompt sent
to whatever model you configured (or a local fallback if you configured none).

It's designed to run entirely in the **browser**.

## Installation [#installation]

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @drincs/pixi-vn-ai @drincs/pixi-vn ai @mlc-ai/web-llm
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @drincs/pixi-vn-ai @drincs/pixi-vn ai @mlc-ai/web-llm
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @drincs/pixi-vn-ai @drincs/pixi-vn ai @mlc-ai/web-llm
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @drincs/pixi-vn-ai @drincs/pixi-vn ai @mlc-ai/web-llm
    ```
  </CodeBlockTab>
</CodeBlockTabs>

* `@drincs/pixi-vn` — the visual novel engine this library is built for.
* `ai` ([AI SDK](https://ai-sdk.dev)) — used to talk to any AI SDK-compatible model (OpenAI,
  Anthropic, Google, Ollama, ...).
* `@mlc-ai/web-llm` — powers the built-in local fallback model (see below), so you never *have* to
  configure a provider to get started.

## Initializing [#initializing]

Call `ai.init(...)` once, at startup:

```ts
import { ai } from "@drincs/pixi-vn-ai";

await ai.init();
```

With no arguments, `ai.init()` downloads and runs a small local [WebLLM](https://github.com/mlc-ai/web-llm)
model (`SmolLM2-360M-Instruct`) directly in the browser — no API key, no server, nothing to
configure. This covers `ai.text.generateDialog` out of the box. **WebLLM cannot generate images**,
so `ai.image.generateBackground`/`ai.image.generateElement` require an external model regardless.

To use a specific model instead, pass it through [`ai` (the AI SDK)](https://ai-sdk.dev/providers):

```ts
import { ai } from "@drincs/pixi-vn-ai";
import { openai } from "@ai-sdk/openai";

await ai.init({
  textProvider: openai("gpt-5"),
  imageProvider: openai.image("gpt-image-1"),
});
```

* `textProvider` is a [`LanguageModel`](https://ai-sdk.dev/docs/foundations/providers-and-models)
  from any AI SDK provider. It drives `ai.text.generateDialog`, and is also used as a fallback for
  image generation on multimodal models (e.g. Gemini's image generation).
* `imageProvider` is an [`ImageModel`](https://ai-sdk.dev/docs/ai-sdk-core/image-generation) from
  any AI SDK provider. It drives `ai.image.generateBackground`/`ai.image.generateElement`.

You don't need both: set only `textProvider` for dialogue (images keep needing one of the two, as
above), only `imageProvider` for images, or both.

### Using ComfyUI for images [#using-comfyui-for-images]

If you want to generate images with a self-hosted [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
server instead, also install:

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm install @stable-canvas/comfyui-client
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @stable-canvas/comfyui-client
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @stable-canvas/comfyui-client
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @stable-canvas/comfyui-client
    ```
  </CodeBlockTab>
</CodeBlockTabs>

If you'd rather generate images with your own self-hosted [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
server, pass a `ComfyUIImageModel` as `imageProvider`:

```ts
import { ai } from "@drincs/pixi-vn-ai";
import { ComfyUIImageModel } from "@drincs/pixi-vn-ai/comfyui";
import myWorkflow from "./my-workflow-api.json"; // exported from ComfyUI's "Save (API Format)"

await ai.init({
  imageProvider: new ComfyUIImageModel({
    apiHost: "127.0.0.1:8188",
    workflow: myWorkflow,
    // the node/input in `myWorkflow` that holds the positive prompt (usually a CLIPTextEncode node)
    promptNodeId: "6",
    promptInputName: "text", // optional, defaults to "text"
  }),
});
```

Since ComfyUI runs an arbitrary node graph rather than accepting a plain prompt, `ComfyUIImageModel`
only injects the developer request into the node/input you point it at — everything else
(checkpoint, sampler, seed, resolution, ...) is whatever your exported workflow already specifies.

## Usage [#usage]

### `ai.text.generateDialog` [#aitextgeneratedialog]

```ts
const line = await ai.text.generateDialog(
  "The advisor reassures the king that the kingdom is safe.",
  {
    history: true,
    scene: "The throne room, late at night, lit only by torches.",
    style: "Tense, formal, a little melancholic.",
    language: "English",
    context: "The king has not slept in three days.",
    speaker: "advisor",
    listeners: ["king"],
  },
);
```

Generates a line of dialogue. `history` (on by default) pulls Pixi'VN's narrative history so the
model has continuity; `scene`/`style`/`context` steer tone and setting; `language` fixes the output
language; `speaker`/`listeners` accept a character ID (resolved against Pixi'VN's
`RegisteredCharacters`, or used as-is if not registered) or an object, single or array.

<details>
<summary>Prompt generated by the call above</summary>

````text
### Instructions

You are generating narrative dialogue for a visual novel.
Generate Markdown text.
Keep the Markdown simple and readable.
Do not use headings.
Do not use tables.
Do not use unnecessary lists.
Use bold and italic only when they improve readability.
HTML is allowed only when necessary; prefer <span> for styling (e.g. colors). Avoid excessive HTML usage.
Return only the generated content.
Do not explain the generated result.

### Developer Request

The advisor reassures the king that the kingdom is safe.

### Narrative History

The narrative history so far, serialized as JSON.

​```
[
  {
    "stepIndex": 4,
    "dialogue": {
      "character": "advisor",
      "text": "Your Majesty, the council awaits your decision."
    }
  }
]
​```

### Scene

The throne room, late at night, lit only by torches.

### Style

Tense, formal, a little melancholic.

### Language

The language the generated content must be written in.

​```
English
​```

### Context

The king has not slept in three days.

### Speaker

The character(s) speaking, serialized as JSON.

​```
[
  {
    "id": "advisor"
  }
]
​```

### Listeners

The character(s) receiving the dialogue, serialized as JSON.

​```
[
  {
    "id": "king"
  }
]
​```
````

(`Narrative History` is read automatically from Pixi'VN — shown here as an example. `Speaker`/
`Listeners` show the `{ id }` fallback for an unregistered character; a registered one would include
its full data instead.)

</details>

### `ai.image.generateBackground` [#aiimagegeneratebackground]

```ts
const background = await ai.image.generateBackground(
  "The throne room, lit by torches, a storm outside the windows.",
  {
    history: false,
    scene: "Night, medieval castle interior.",
    style: "Oil painting, warm color palette.",
    context:
      "This will be used as the main backdrop for the throne room scenes.",
    referenceImage: "throne-room-sketch",
  },
);
```

Generates a background meant to fill the whole game canvas. Its size is read directly from Pixi'VN
and included in the prompt automatically — you never pass it. `referenceImage` is a Pixi'VN asset
alias (or a URL/data URI); when given, it's used as image-to-image guidance.

<details>
<summary>Prompt generated by the call above</summary>

````text
### Instructions

You are generating a background illustration for a visual novel scene.
This image fills the entire game canvas: match the canvas size given below and cover the full frame edge-to-edge, with no borders, letterboxing or unused margins.
If a reference image is provided, use it as the basis for the generated image.
Otherwise, generate the image purely from the textual context below.
Match the requested scene, style and subjects as closely as possible.

### Developer Request

The throne room, lit by torches, a storm outside the windows.

### Scene

Night, medieval castle interior.

### Style

Oil painting, warm color palette.

### Context

This will be used as the main backdrop for the throne room scenes.

### Reference Image

A reference image has been provided, encoded as a base64 data URI, and should be used as visual guidance.

​```
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA... (truncated)
​```

### Canvas Size

1920x1080
````

</details>

### `ai.image.generateElement` [#aiimagegenerateelement]

```ts
const advisorSprite = await ai.image.generateElement(
  "The advisor, an elderly man with a long grey beard, wearing dark blue robes, worried expression.",
  {
    history: false,
    scene: "Standing in the throne room.",
    style: "Oil painting, warm color palette, matching the background.",
    context: "This character will be reused across multiple scenes.",
    referenceImage: "advisor-concept-art",
    backgroundImage: "throne-room-background",
    align: { x: 0.75, y: 1 },
  },
);
```

Generates a single element (typically a character) meant to be layered on top of other visuals,
with a transparent background. `backgroundImage` (a Pixi'VN asset alias, or `true` to capture
whatever is currently on the game canvas) gives the model visual context on what it's being
composited over; `align` tells it where on screen it'll be placed, so it can compose accordingly.
When both `referenceImage` and `backgroundImage` are set, both appear in the prompt, but only
`referenceImage` is actually forwarded to the model as an image-to-image reference.

<details>
<summary>Prompt generated by the call above</summary>

````text
### Instructions

You are generating a single visual element (e.g. a character) for a visual novel, meant to be layered on top of a background.
The area behind the subject must be fully transparent: do not generate any background, ground or scenery of your own.
If a background reference image is provided, use it only to match lighting, perspective and scale; do not reproduce it.
If alignment values are provided, compose the subject so it reads naturally when placed at that position on screen.
Match the requested scene, style and subjects as closely as possible.

### Developer Request

The advisor, an elderly man with a long grey beard, wearing dark blue robes, worried expression.

### Scene

Standing in the throne room.

### Style

Oil painting, warm color palette, matching the background.

### Context

This character will be reused across multiple scenes.

### Reference Image

A reference image has been provided, encoded as a base64 data URI, and should be used as visual guidance.

​```
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA... (truncated)
​```

### Background Reference

The background image this element will be placed over, encoded as a base64 data URI: use it as visual guidance for lighting, perspective and scale.

​```
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA... (truncated)
​```

### Alignment

Where the element will be positioned on the canvas: x and y are each a 0-1 fraction of the canvas' width/height, and that same fraction is also used as the element's own anchor point, so the value describes both where on the canvas the point sits and which point of the element is placed there. 0 = the element's left/top edge is flush against the canvas' left/top edge, 1 = the element's right/bottom edge is flush against the canvas' right/bottom edge, 0.5 = the element is centered on that axis.

​```
{
  "x": 0.75,
  "y": 1
}
​```
````

</details>

## Customizing the prompt templates [#customizing-the-prompt-templates]

Every generated prompt starts from a built-in "Instructions" template, which you can override per
kind:

```ts
ai.templates.dialog = { instructions: "..." };
ai.templates.image.background = { instructions: "..." };
ai.templates.image.element = { instructions: "..." };
```


# Class: AIImageSprite<Memory> (/pixi-vn-ai/index/classes/AIImageSprite)



Defined in: [src/canvas/AIImageSprite.ts:38](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L38)

An ImageSprite for images produced by `ai.image.generateBackground`/
`ai.image.generateElement`. It behaves exactly like ImageSprite, but also keeps the
generated image (a data URI) in its [memory](#memory-1), so that save games store the generated
image itself and can restore the exact same image on load, instead of calling the AI provider
again (which would produce a different image).

## Example [#example]

```ts
const dataUri = await ai.image.generateBackground("The throne room, lit by torches.");
const sprite = new AIImageSprite(undefined, dataUri);
await sprite.load();
canvas.add("background", sprite);
```

## Extends [#extends]

* `ImageSprite`\<`Memory`>

## Type Parameters [#type-parameters]

### Memory [#memory]

`Memory` *extends* [`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory) = [`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)

## Constructors [#constructors]

### Constructor [#constructor]

\> **new AIImageSprite**\<`Memory`>(`options?`, `generatedImage?`): `AIImageSprite`\<`Memory`>

Defined in: [src/canvas/AIImageSprite.ts:49](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L49)

#### Parameters [#parameters]

##### options? [#options]

`ImageSpriteOptions` | `Omit`\<`Texture`\<`TextureSource`\<`any`>>, `"on"`>

The options for the component.

##### generatedImage? [#generatedimage]

`string`

The image generated by `ai.image.generateBackground`/
`ai.image.generateElement`, as a data URI.

#### Returns [#returns]

`AIImageSprite`\<`Memory`>

#### Overrides [#overrides]

`ImageSprite<Memory>.constructor`

## Properties [#properties]

### \_\_devtoolIgnore? [#__devtoolignore]

\> `optional` **\_\_devtoolIgnore?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:35

#### Inherited from [#inherited-from]

`ImageSprite.__devtoolIgnore`

***

### \_\_devtoolIgnoreChildren? [#__devtoolignorechildren]

\> `optional` **\_\_devtoolIgnoreChildren?**: `string`

Defined in: node_modules/@pixi/devtools/global.d.ts:36

#### Inherited from [#inherited-from-1]

`ImageSprite.__devtoolIgnoreChildren`

***

### \_\_devtoolLocked? [#__devtoollocked]

\> `optional` **\_\_devtoolLocked?**: `boolean`

Defined in: node_modules/@pixi/devtools/global.d.ts:37

#### Inherited from [#inherited-from-2]

`ImageSprite.__devtoolLocked`

***

### \_anchor [#_anchor]

\> `readonly` **\_anchor**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:155

**`Internal`**

#### Inherited from [#inherited-from-3]

`ImageSprite._anchor`

***

### \_bounds [#_bounds]

\> `protected` **\_bounds**: `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:59

#### Inherited from [#inherited-from-4]

`ImageSprite._bounds`

***

### \_boundsDirty [#_boundsdirty]

\> `protected` **\_boundsDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:60

#### Inherited from [#inherited-from-5]

`ImageSprite._boundsDirty`

***

### \_cx [#_cx]

\> **\_cx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:751

**`Internal`**

The X-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-6]

`ImageSprite._cx`

***

### \_cy [#_cy]

\> **\_cy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:763

**`Internal`**

The X-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-7]

`ImageSprite._cy`

***

### \_gcData? [#_gcdata]

\> `optional` **\_gcData?**: `GCData`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:54

**`Internal`**

#### Inherited from [#inherited-from-8]

`ImageSprite._gcData`

***

### \_gcLastUsed [#_gclastused]

\> **\_gcLastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:58

**`Internal`**

#### Inherited from [#inherited-from-9]

`ImageSprite._gcLastUsed`

***

### \_gpuData [#_gpudata]

\> **\_gpuData**: `Record`\<`number`, `GPU_DATA`>

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:52

**`Internal`**

#### Inherited from [#inherited-from-10]

`ImageSprite._gpuData`

***

### \_lastUsed [#_lastused]

\> **\_lastUsed**: `number`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:50

**`Internal`**

#### Inherited from [#inherited-from-11]

`ImageSprite._lastUsed`

***

### \_pivot [#_pivot]

\> **\_pivot**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:734

**`Internal`**

The pivot point of the container that it rotates around.

#### Inherited from [#inherited-from-12]

`ImageSprite._pivot`

***

### \_position [#_position]

\> **\_position**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:724

**`Internal`**

The coordinate of the object relative to the local coordinates of the parent.

#### Inherited from [#inherited-from-13]

`ImageSprite._position`

***

### \_roundPixels [#_roundpixels]

\> **\_roundPixels**: `0` | `1`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:48

**`Internal`**

#### Inherited from [#inherited-from-14]

`ImageSprite._roundPixels`

***

### \_scale [#_scale]

\> **\_scale**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:729

**`Internal`**

The scale factor of the object.

#### Inherited from [#inherited-from-15]

`ImageSprite._scale`

***

### \_skew [#_skew]

\> **\_skew**: `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:745

**`Internal`**

The skew amount, on the x and y axis.

#### Inherited from [#inherited-from-16]

`ImageSprite._skew`

***

### \_sx [#_sx]

\> **\_sx**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:757

**`Internal`**

The Y-coordinate value of the normalized local X axis,
the first column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-17]

`ImageSprite._sx`

***

### \_sy [#_sy]

\> **\_sy**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:769

**`Internal`**

The Y-coordinate value of the normalized local Y axis,
the second column of the local transformation matrix without a scale.

#### Inherited from [#inherited-from-18]

`ImageSprite._sy`

***

### \_texture [#_texture]

\> **\_texture**: `Texture`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:157

**`Internal`**

#### Inherited from [#inherited-from-19]

`ImageSprite._texture`

***

### \_zIndex [#_zindex]

\> **\_zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:60

**`Internal`**

#### Inherited from [#inherited-from-20]

`ImageSprite._zIndex`

***

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from-21]

`ImageSprite.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-22]

`ImageSprite.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-23]

`ImageSprite.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-24]

`ImageSprite.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-25]

`ImageSprite.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-26]

`ImageSprite.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-7]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-27]

`ImageSprite.accessibleType`

***

### allowChildren [#allowchildren]

\> **allowChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:46

**`Internal`**

#### Inherited from [#inherited-from-28]

`ImageSprite.allowChildren`

***

### autoGarbageCollect [#autogarbagecollect]

\> **autoGarbageCollect**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:56

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-29]

`ImageSprite.autoGarbageCollect`

***

### batched [#batched]

\> **batched**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:153

**`Internal`**

#### Inherited from [#inherited-from-30]

`ImageSprite.batched`

***

### boundsArea [#boundsarea]

\> **boundsArea**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:815

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-8]

```ts
const container = new Container();
container.boundsArea = new Rectangle(0, 0, 500, 500);
```

#### Inherited from [#inherited-from-31]

`ImageSprite.boundsArea`

***

### ~~cacheAsBitmap~~ [#cacheasbitmap]

\> **cacheAsBitmap**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:61

Legacy property for backwards compatibility with PixiJS v7 and below.
Use `cacheAsTexture` instead.

#### Deprecated [#deprecated]

since 8.0.0

#### Inherited from [#inherited-from-32]

`ImageSprite.cacheAsBitmap`

***

### cacheAsTexture [#cacheastexture]

\> **cacheAsTexture**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:45

Caches this container as a texture. This allows the container to be rendered as a single texture,
which can improve performance for complex static containers.

#### Parameters [#parameters-1]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

If true, enables caching with default options.
If false, disables caching.
Can also pass options object to configure caching behavior.

#### Returns [#returns-1]

`void`

#### Example [#example-9]

```ts
// Basic caching
container.cacheAsTexture(true);

// With custom options
container.cacheAsTexture({
    resolution: 2,
    antialias: true,
});

// Disable caching
container.cacheAsTexture(false);

// Cache a complex UI
const ui = new Container();
// Add multiple children...
ui.cacheAsTexture(true);
ui.updateCacheTexture(); // Update if contents change
```

#### See [#see]

* Container#updateCacheTexture For updating cached content
* [Container#isCachedAsTexture](#iscachedastexture) For checking cache state

#### Inherited from [#inherited-from-33]

`ImageSprite.cacheAsTexture`

***

### canBundle [#canbundle]

\> `readonly` **canBundle**: `true` = `true`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:44

**`Internal`**

#### Inherited from [#inherited-from-34]

`ImageSprite.canBundle`

***

### children [#children]

\> `readonly` **children**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:639

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-10]

```ts
// Access children
const firstChild = container.children[0];
const lastChild = container.children[container.children.length - 1];
```

#### See [#see-1]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-35]

`ImageSprite.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-11]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-7]

```ts
false
```

#### Inherited from [#inherited-from-36]

`ImageSprite.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-12]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-8]

```ts
true
```

#### Inherited from [#inherited-from-37]

`ImageSprite.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-13]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-9]

```ts
null
```

#### Inherited from [#inherited-from-38]

`ImageSprite.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `string` & `object` | `Cursor`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-14]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-10]

```ts
undefined
```

#### See [#see-2]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-39]

`ImageSprite.cursor`

***

### depthOfChildModified [#depthofchildmodified]

\> **depthOfChildModified**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:74

**`Internal`**

#### Returns [#returns-2]

`void`

#### Inherited from [#inherited-from-40]

`ImageSprite.depthOfChildModified`

***

### destroyed [#destroyed]

\> **destroyed**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:719

Whether this object has been destroyed. If true, the object should no longer be used.
After an object is destroyed, all of its functionality is disabled and references are removed.

#### Example [#example-15]

```ts
// Cleanup with destroy
sprite.destroy();
console.log(sprite.destroyed); // true
```

#### Default [#default-11]

```ts
false
```

#### See [#see-3]

Container#destroy For destroying objects

#### Inherited from [#inherited-from-41]

`ImageSprite.destroyed`

***

### effects? [#effects]

\> `optional` **effects?**: `Effect`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:183

todo Needs docs

#### Advanced [#advanced-3]

#### Inherited from [#inherited-from-42]

`ImageSprite.effects`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-16]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-43]

`ImageSprite.eventMode`

***

### filterArea? [#filterarea]

\> `optional` **filterArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:178

The area the filter is applied to. This is used as an optimization to define a specific region
for filter effects instead of calculating the display object bounds each frame.

\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for filter effects,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-17]

```ts
// Set specific filter area
container.filterArea = new Rectangle(0, 0, 100, 100);

// Optimize filter region
const screen = app.screen;
container.filterArea = new Rectangle(
    screen.x,
    screen.y,
    screen.width,
    screen.height
);
```

#### See [#see-4]

* Container#filters For applying filters
* Rectangle For area definition

#### Inherited from [#inherited-from-44]

`ImageSprite.filterArea`

***

### globalDisplayStatus [#globaldisplaystatus]

\> **globalDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:798

**`Internal`**

#### Inherited from [#inherited-from-45]

`ImageSprite.globalDisplayStatus`

***

### groupAlpha [#groupalpha]

\> **groupAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:780

**`Internal`**

#### Inherited from [#inherited-from-46]

`ImageSprite.groupAlpha`

***

### groupBlendMode [#groupblendmode]

\> **groupBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:788

**`Internal`**

#### Inherited from [#inherited-from-47]

`ImageSprite.groupBlendMode`

***

### groupColor [#groupcolor]

\> **groupColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:782

**`Internal`**

#### Inherited from [#inherited-from-48]

`ImageSprite.groupColor`

***

### groupColorAlpha [#groupcoloralpha]

\> **groupColorAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:784

**`Internal`**

#### Inherited from [#inherited-from-49]

`ImageSprite.groupColorAlpha`

***

### groupTransform [#grouptransform]

\> `readonly` **groupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:705

The group transform is a transform relative to the render group it belongs too.
If this container is render group then this will be an identity matrix. other wise it
will be the same as the relativeGroupTransform.
Use this value when actually rendering things to the screen

#### Advanced [#advanced-4]

#### Inherited from [#inherited-from-50]

`ImageSprite.groupTransform`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-18]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-51]

`ImageSprite.hitArea`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](#eventmode)

#### Example [#example-19]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-52]

`ImageSprite.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-12]

```ts
true
```

#### Example [#example-20]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-53]

`ImageSprite.interactiveChildren`

***

### isCachedAsTexture [#iscachedastexture]

\> `readonly` **isCachedAsTexture**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:75

Whether this container is currently cached as a texture.

#### Example [#example-21]

```ts
// Check cache state
if (container.isCachedAsTexture) {
    console.log('Container is cached');
}
```

#### See [#see-6]

* Container#cacheAsTexture For enabling caching
* Container#updateCacheTexture For updating cache

#### Inherited from [#inherited-from-54]

`ImageSprite.isCachedAsTexture`

***

### isInteractive [#isinteractive]

\> **isInteractive**: () => `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1040

Determines if the container is interactive or not

#### Returns [#returns-3]

`boolean`

Whether the container is interactive or not

#### Since [#since-1]

7.2.0

#### Example [#example-22]

```ts
import { Sprite } from 'pixi.js';

const sprite = new Sprite(texture);
sprite.eventMode = 'static';
sprite.isInteractive(); // true

sprite.eventMode = 'dynamic';
sprite.isInteractive(); // true

sprite.eventMode = 'none';
sprite.isInteractive(); // false

sprite.eventMode = 'passive';
sprite.isInteractive(); // false

sprite.eventMode = 'auto';
sprite.isInteractive(); // false
```

#### Inherited from [#inherited-from-55]

`ImageSprite.isInteractive`

***

### label [#label]

\> **label**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-13]

```ts
null
```

#### Inherited from [#inherited-from-56]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory).[`label`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory#label)

***

### layerParentId [#layerparentid]

\> **layerParentId**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:829

**`Internal`**

#### Inherited from [#inherited-from-57]

`ImageSprite.layerParentId`

***

### localAlpha [#localalpha]

\> **localAlpha**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:778

**`Internal`**

#### Inherited from [#inherited-from-58]

`ImageSprite.localAlpha`

***

### localBlendMode [#localblendmode]

\> **localBlendMode**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:786

**`Internal`**

#### Inherited from [#inherited-from-59]

`ImageSprite.localBlendMode`

***

### localColor [#localcolor]

\> **localColor**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:776

**`Internal`**

#### Inherited from [#inherited-from-60]

`ImageSprite.localColor`

***

### localDisplayStatus [#localdisplaystatus]

\> **localDisplayStatus**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:796

**`Internal`**

This property holds three bits: culled, visible, renderable
the third bit represents culling (0 = culled, 1 = not culled) 0b100
the second bit represents visibility (0 = not visible, 1 = visible) 0b010
the first bit represents renderable (0 = not renderable, 1 = renderable) 0b001

#### Inherited from [#inherited-from-61]

`ImageSprite.localDisplayStatus`

***

### localTransform [#localtransform]

\> `readonly` **localTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:688

Current transform of the object based on local factors: position, scale, other stuff.
This matrix represents the local transformation without any parent influence.

#### Example [#example-23]

```ts
// Basic transform access
const localMatrix = sprite.localTransform;
console.log(localMatrix.toString());
```

#### See [#see-7]

* Container#worldTransform For global transform
* Container#groupTransform For render group transform

#### Inherited from [#inherited-from-62]

`ImageSprite.localTransform`

***

### mask [#mask]

\> **mask**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:254

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it.

\> \[!IMPORTANT] In PixiJS a regular mask must be a Graphics or a Sprite object.
\> This allows for much faster masking in canvas as it uses shape clipping.
\> A mask of an object must be in the subtree of its parent.
\> Otherwise, `getLocalBounds` may calculate incorrect bounds, which makes the container's width and height wrong.

Sprite masks read the red channel by default. Use [Container#setMask](#setmask) with `channel: 'alpha'`
to read the alpha channel instead. See MaskOptions#channel for details.

#### Example [#example-24]

```ts
// Apply mask to sprite
const sprite = new Sprite(texture);
sprite.mask = graphics;

// Remove mask
sprite.mask = null;
```

#### See [#see-8]

* Graphics For creating mask shapes
* Sprite For texture-based masks
* [Container#setMask](#setmask) For advanced mask options including channel selection

#### Inherited from [#inherited-from-63]

`ImageSprite.mask`

***

### ~~name~~ [#name]

\> **name**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:24

The instance name of the object.

#### Deprecated [#deprecated-1]

since 8.0.0

#### See [#see-9]

Container#label

#### Default [#default-14]

```ts
null
```

#### Inherited from [#inherited-from-64]

`ImageSprite.name`

***

### onclick? [#onclick]

\> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) => {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) => {
    console.log('Clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-15]

```ts
null
```

#### Inherited from [#inherited-from-65]

`ImageSprite.onclick`

***

### onEventsHandlers [#oneventshandlers]

\> `readonly` **onEventsHandlers**: `OnEventsHandlers`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:759

ListenerExtension

#### Inherited from [#inherited-from-66]

`ImageSprite.onEventsHandlers`

***

### onglobalmousemove? [#onglobalmousemove]

\> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) => {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-16]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-67]

`ImageSprite.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

\> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-17]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-68]

`ImageSprite.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

\> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-69]

`ImageSprite.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

\> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) => {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) => {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-19]

```ts
null
```

#### Inherited from [#inherited-from-70]

`ImageSprite.onmousedown`

***

### onmouseenter? [#onmouseenter]

\> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) => {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-20]

```ts
null
```

#### Inherited from [#inherited-from-71]

`ImageSprite.onmouseenter`

***

### onmouseleave? [#onmouseleave]

\> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-72]

`ImageSprite.onmouseleave`

***

### onmousemove? [#onmousemove]

\> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) => {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) => {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-73]

`ImageSprite.onmousemove`

***

### onmouseout? [#onmouseout]

\> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-74]

`ImageSprite.onmouseout`

***

### onmouseover? [#onmouseover]

\> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) => {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) => {
    sprite.scale.set(1.1);
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-75]

`ImageSprite.onmouseover`

***

### onmouseup? [#onmouseup]

\> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) => {
     sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-76]

`ImageSprite.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

\> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-77]

`ImageSprite.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

\> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-78]

`ImageSprite.onpointercancel`

***

### onpointerdown? [#onpointerdown]

\> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-79]

`ImageSprite.onpointerdown`

***

### onpointerenter? [#onpointerenter]

\> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-80]

`ImageSprite.onpointerenter`

***

### onpointerleave? [#onpointerleave]

\> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-81]

`ImageSprite.onpointerleave`

***

### onpointermove? [#onpointermove]

\> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-82]

`ImageSprite.onpointermove`

***

### onpointerout? [#onpointerout]

\> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) => {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-83]

`ImageSprite.onpointerout`

***

### onpointerover? [#onpointerover]

\> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) => {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) => {
    sprite.scale.set(1.2);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-84]

`ImageSprite.onpointerover`

***

### onpointertap? [#onpointertap]

\> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-85]

`ImageSprite.onpointertap`

***

### onpointerup? [#onpointerup]

\> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-45]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-86]

`ImageSprite.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

\> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-87]

`ImageSprite.onpointerupoutside`

***

### onRender [#onrender]

\> **onRender**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

\> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
\> and "updateTransform" is no longer called every frame

#### Example [#example-47]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () => {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-10]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-88]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory).[`onRender`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory#onrender)

***

### onrightclick? [#onrightclick]

\> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) => {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-89]

`ImageSprite.onrightclick`

***

### onrightdown? [#onrightdown]

\> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-90]

`ImageSprite.onrightdown`

***

### onrightup? [#onrightup]

\> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-91]

`ImageSprite.onrightup`

***

### onrightupoutside? [#onrightupoutside]

\> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-92]

`ImageSprite.onrightupoutside`

***

### ontap? [#ontap]

\> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) => {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-93]

`ImageSprite.ontap`

***

### ontouchcancel? [#ontouchcancel]

\> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) => {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-94]

`ImageSprite.ontouchcancel`

***

### ontouchend? [#ontouchend]

\> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) => {
   sprite.scale.set(1.0);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-95]

`ImageSprite.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

\> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) => {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) => {
    sprite.scale.set(1.0);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-96]

`ImageSprite.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

\> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) => {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) => {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-97]

`ImageSprite.ontouchmove`

***

### ontouchstart? [#ontouchstart]

\> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-57]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) => {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) => {
    sprite.scale.set(0.9);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-98]

`ImageSprite.ontouchstart`

***

### onwheel? [#onwheel]

\> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-58]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) => {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-99]

`ImageSprite.onwheel`

***

### parent [#parent]

\> `readonly` **parent**: `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:659

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### Example [#example-59]

```ts
// Basic parent access
const parent = sprite.parent;

// Walk up the tree
let current = sprite;
while (current.parent) {
    console.log('Level up:', current.parent.constructor.name);
    current = current.parent;
}
```

#### See [#see-11]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-100]

`ImageSprite.parent`

***

### parentRenderLayer [#parentrenderlayer]

\> `readonly` **parentRenderLayer**: `RenderLayer` | `null`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:672

The RenderLayer this container belongs to, if any.
If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.

#### Advanced [#advanced-5]

#### Inherited from [#inherited-from-101]

`ImageSprite.parentRenderLayer`

***

### pixivnId [#pixivnid]

\> `readonly` **pixivnId**: `string` = `AI_IMAGE_SPRITE_ID`

Defined in: [src/canvas/AIImageSprite.ts:41](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L41)

#### Overrides [#overrides-1]

`ImageSprite.pixivnId`

***

### relativeGroupTransform [#relativegrouptransform]

\> `readonly` **relativeGroupTransform**: `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:696

The relative group transform is a transform relative to the render group it belongs too. It will include all parent
transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested).
If this container is is self a render group matrix will be relative to its parent render group

#### Advanced [#advanced-6]

#### Inherited from [#inherited-from-102]

`ImageSprite.relativeGroupTransform`

***

### renderPipeId [#renderpipeid]

\> `readonly` **renderPipeId**: `string`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:151

**`Internal`**

#### Inherited from [#inherited-from-103]

`ImageSprite.renderPipeId`

***

### sortableChildren [#sortablechildren]

\> **sortableChildren**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

\> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
\> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-60]

```ts
container.sortableChildren = true;
```

#### Default [#default-48]

```ts
false
```

#### Inherited from [#inherited-from-104]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory).[`sortableChildren`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory#sortablechildren)

***

### sortChildren [#sortchildren]

\> **sortChildren**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:72

Sorts children by zIndex value. Only sorts if container is marked as dirty.

#### Returns [#returns-4]

`void`

#### Example [#example-61]

```ts
// Basic sorting
particles.zIndex = 2;     // Will mark as dirty
container.sortChildren();
```

#### See [#see-12]

* [Container#sortableChildren](#sortablechildren) For enabling automatic sorting
* [Container#zIndex](#zindex) For setting child order

#### Inherited from [#inherited-from-105]

`ImageSprite.sortChildren`

***

### sortDirty [#sortdirty]

\> **sortDirty**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-49]

```ts
false
@internal
```

#### Inherited from [#inherited-from-106]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory).[`sortDirty`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory#sortdirty)

***

### tabIndex? [#tabindex]

\> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-50]

```ts
0
```

#### Example [#example-62]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-107]

`ImageSprite.tabIndex`

***

### uid [#uid]

\> `readonly` **uid**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:610

**`Internal`**

unique id for this container

#### Inherited from [#inherited-from-108]

`ImageSprite.uid`

***

### updateCacheTexture [#updatecachetexture]

\> **updateCacheTexture**: () => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:55

Updates the cached texture of this container. This will flag the container's cached texture
to be redrawn on the next render.

#### Returns [#returns-5]

`void`

#### Example [#example-63]

```ts
// Basic update after changes
container.updateCacheTexture();
```

#### Inherited from [#inherited-from-109]

`ImageSprite.updateCacheTexture`

***

### updateTick [#updatetick]

\> **updateTick**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:674

**`Internal`**

#### Inherited from [#inherited-from-110]

`ImageSprite.updateTick`

***

### zIndex [#zindex]

\> **zIndex**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-64]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-13]

* [Container#sortableChildren](#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-51]

```ts
0
```

#### Inherited from [#inherited-from-111]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory).[`zIndex`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory#zindex)

***

### prefixed [#prefixed]

\> `static` **prefixed**: `string` | `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:9

#### Inherited from [#inherited-from-112]

`ImageSprite.prefixed`

## Accessors [#accessors]

### align [#align]

#### Get Signature [#get-signature]

\> **get** **align**(): `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:776

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-6]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature]

\> **set** **align**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:775

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-2]

###### value [#value]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-7]

`void`

#### Inherited from [#inherited-from-113]

`ImageSprite.align`

***

### alpha [#alpha]

#### Get Signature [#get-signature-1]

\> **get** **alpha**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1246

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

##### Example [#example-65]

```ts
// Basic transparency
sprite.alpha = 0.5; // 50% opacity

// Inherited opacity
container.alpha = 0.5;
const child = new Sprite(texture);
child.alpha = 0.5;
container.addChild(child);
// child's effective opacity is 0.25 (0.5 * 0.5)
```

##### Default [#default-52]

```ts
1
```

##### See [#see-14]

* Container#visible For toggling visibility
* Container#renderable For render control

##### Returns [#returns-8]

`number`

#### Set Signature [#set-signature-1]

\> **set** **alpha**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1226

##### Parameters [#parameters-3]

###### value [#value-1]

`number`

##### Returns [#returns-9]

`void`

#### Inherited from [#inherited-from-114]

`ImageSprite.alpha`

***

### anchor [#anchor]

#### Get Signature [#get-signature-2]

\> **get** **anchor**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:256

The anchor sets the origin point of the sprite. The default value is taken from the Texture
and passed to the constructor.

* The default is `(0,0)`, this means the sprite's origin is the top left.
* Setting the anchor to `(0.5,0.5)` means the sprite's origin is centered.
* Setting the anchor to `(1,1)` would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

##### Example [#example-66]

```ts
// Center the anchor point
sprite.anchor = 0.5; // Sets both x and y to 0.5
sprite.position.set(400, 300); // Sprite will be centered at this position

// Set specific x/y anchor points
sprite.anchor = {
    x: 1, // Right edge
    y: 0  // Top edge
};

// Using individual coordinates
sprite.anchor.set(0.5, 1); // Center-bottom

// For rotation around center
sprite.anchor.set(0.5);
sprite.rotation = Math.PI / 4; // 45 degrees around center

// For scaling from center
sprite.anchor.set(0.5);
sprite.scale.set(2); // Scales from center point
```

##### Returns [#returns-10]

`ObservablePoint`

#### Set Signature [#set-signature-2]

\> **set** **anchor**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:257

##### Parameters [#parameters-4]

###### value [#value-2]

`number` | `PointData`

##### Returns [#returns-11]

`void`

#### Inherited from [#inherited-from-115]

`ImageSprite.anchor`

***

### angle [#angle]

#### Get Signature [#get-signature-3]

\> **get** **angle**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1008

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-67]

```ts
// Basic angle rotation
sprite.angle = 45; // 45 degrees

// Rotate around center
sprite.pivot.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Rotate around center with origin
sprite.origin.set(sprite.width / 2, sprite.height / 2);
sprite.angle = 180; // Half rotation

// Reset rotation
sprite.angle = 0;
```

##### Returns [#returns-12]

`number`

#### Set Signature [#set-signature-3]

\> **set** **angle**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1009

##### Parameters [#parameters-5]

###### value [#value-3]

`number`

##### Returns [#returns-13]

`void`

#### Inherited from [#inherited-from-116]

`ImageSprite.angle`

***

### blendMode [#blendmode]

#### Get Signature [#get-signature-4]

\> **get** **blendMode**(): `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1289

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

##### Example [#example-68]

```ts
// Basic blend modes
sprite.blendMode = 'add';        // Additive blending
sprite.blendMode = 'multiply';   // Multiply colors
sprite.blendMode = 'screen';     // Screen blend

// Reset blend mode
sprite.blendMode = 'normal';     // Normal blending
```

##### Default [#default-53]

```ts
'normal'
```

##### See [#see-15]

* Container#alpha For transparency
* Container#tint For color adjustments

##### Returns [#returns-14]

`BLEND_MODES`

#### Set Signature [#set-signature-4]

\> **set** **blendMode**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1269

##### Parameters [#parameters-6]

###### value [#value-4]

`BLEND_MODES`

##### Returns [#returns-15]

`void`

#### Inherited from [#inherited-from-117]

`ImageSprite.blendMode`

***

### bounds [#bounds]

#### Get Signature [#get-signature-5]

\> **get** **bounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:74

The local bounds of the view in its own coordinate space.
Bounds are automatically updated when the view's content changes.

##### Example [#example-69]

```ts
// Get bounds dimensions
const bounds = view.bounds;
console.log(`Width: ${bounds.maxX - bounds.minX}`);
console.log(`Height: ${bounds.maxY - bounds.minY}`);
```

##### See [#see-16]

Bounds For bounds operations

##### Returns [#returns-16]

`Bounds`

The rectangular bounds of the view

#### Inherited from [#inherited-from-118]

`ImageSprite.bounds`

***

### filters [#filters]

#### Get Signature [#get-signature-6]

\> **get** **filters**(): readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:277

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-70]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

##### See [#see-17]

Filter For filter base class

##### Returns [#returns-17]

readonly `Filter`\[]

#### Set Signature [#set-signature-5]

\> **set** **filters**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:276

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

##### Example [#example-71]

```ts
// Add a single filter
sprite.filters = new BlurFilter(2);

// Apply multiple filters
container.filters = [
    new BlurFilter(2),
    new ColorMatrixFilter(),
];

// Remove filters
sprite.filters = null;
```

##### See [#see-18]

Filter For filter base class

##### Parameters [#parameters-7]

###### value [#value-5]

`Filter` | `Filter`\[] | `null` | `undefined`

##### Returns [#returns-18]

`void`

#### Inherited from [#inherited-from-119]

`ImageSprite.filters`

***

### generatedImage [#generatedimage-1]

#### Get Signature [#get-signature-7]

\> **get** **generatedImage**(): `string` | `undefined`

Defined in: [src/canvas/AIImageSprite.ts:57](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L57)

The generated image (a data URI) currently shown by this sprite, if any.

##### Returns [#returns-19]

`string` | `undefined`

***

### haveEmptyTexture [#haveemptytexture]

#### Get Signature [#get-signature-8]

\> **get** **haveEmptyTexture**(): `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:864

Check if the texture is empty.

##### Returns [#returns-20]

`boolean`

A boolean that is true if the texture is empty.

#### Inherited from [#inherited-from-120]

`ImageSprite.haveEmptyTexture`

***

### height [#height]

#### Get Signature [#get-signature-9]

\> **get** **height**(): `number`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:300

The height of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example [#example-72]

```ts
// Set height directly
sprite.height = 150;
console.log(sprite.scale.y); // Scale adjusted to match height

// Set height while preserving aspect ratio
const ratio = sprite.width / sprite.height;
sprite.height = 200;
sprite.width = 200 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.height = sprite.texture.orig.height;
```

##### Returns [#returns-21]

`number`

#### Set Signature [#set-signature-6]

\> **set** **height**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:301

The height of the Container,
\> \[!NOTE] Changing the height will adjust the scale.y property of the container while maintaining its aspect ratio.
\> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-73]

```ts
// Basic height setting
container.height = 200;
// Optimized height setting
container.setSize(100, 200);
```

##### Parameters [#parameters-8]

###### value [#value-6]

`number`

##### Returns [#returns-22]

`void`

#### Inherited from [#inherited-from-121]

`ImageSprite.height`

***

### isRenderable [#isrenderable]

#### Get Signature [#get-signature-10]

\> **get** **isRenderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1329

Whether or not the object should be rendered.

##### Advanced [#advanced-7]

##### Returns [#returns-23]

`boolean`

#### Inherited from [#inherited-from-122]

`ImageSprite.isRenderable`

***

### isRenderGroup [#isrendergroup]

#### Get Signature [#get-signature-11]

\> **get** **isRenderGroup**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:894

Returns true if this container is a render group.
This means that it will be rendered as a separate pass, with its own set of instructions

##### Advanced [#advanced-8]

##### Returns [#returns-24]

`boolean`

#### Set Signature [#set-signature-7]

\> **set** **isRenderGroup**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:888

##### Parameters [#parameters-9]

###### value [#value-7]

`boolean`

##### Returns [#returns-25]

`void`

#### Inherited from [#inherited-from-123]

`ImageSprite.isRenderGroup`

***

### loadIsStarted [#loadisstarted]

#### Get Signature [#get-signature-12]

\> **get** **loadIsStarted**(): `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:852

##### Returns [#returns-26]

`boolean`

#### Inherited from [#inherited-from-124]

`ImageSprite.loadIsStarted`

***

### memory [#memory-1]

#### Get Signature [#get-signature-13]

\> **get** **memory**(): [`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)

Defined in: [src/canvas/AIImageSprite.ts:61](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L61)

##### Returns [#returns-27]

[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)

#### Overrides [#overrides-2]

`ImageSprite.memory`

***

### origin [#origin]

#### Get Signature [#get-signature-14]

\> **get** **origin**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1087

**`Experimental`**

The origin point around which the container rotates and scales without affecting its position.
Unlike pivot, changing the origin will not move the container's position.

##### Example [#example-74]

```ts
// Rotate around center point
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center

// Reset origin
container.origin.set(0, 0);
```

##### Returns [#returns-28]

`ObservablePoint`

#### Set Signature [#set-signature-8]

\> **set** **origin**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1088

##### Parameters [#parameters-10]

###### value [#value-8]

`number` | `PointData`

##### Returns [#returns-29]

`void`

#### Inherited from [#inherited-from-125]

`ImageSprite.origin`

***

### percentagePosition [#percentageposition]

#### Get Signature [#get-signature-15]

\> **get** **percentagePosition**(): `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:783

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-30]

`number` | `Partial`\<`PointData`>

#### Set Signature [#set-signature-9]

\> **set** **percentagePosition**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:782

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-11]

###### value [#value-9]

`number` | `Partial`\<`PointData`>

##### Returns [#returns-31]

`void`

#### Inherited from [#inherited-from-126]

`ImageSprite.percentagePosition`

***

### percentageX [#percentagex]

#### Get Signature [#get-signature-16]

\> **get** **percentageX**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:784

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-32]

`number`

#### Set Signature [#set-signature-10]

\> **set** **percentageX**(`_value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:785

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-12]

###### \_value [#_value]

`number`

##### Returns [#returns-33]

`void`

#### Inherited from [#inherited-from-127]

`ImageSprite.percentageX`

***

### percentageY [#percentagey]

#### Get Signature [#get-signature-17]

\> **get** **percentageY**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:786

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Returns [#returns-34]

`number`

#### Set Signature [#set-signature-11]

\> **set** **percentageY**(`_value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:787

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

##### Parameters [#parameters-13]

###### \_value [#_value-1]

`number`

##### Returns [#returns-35]

`void`

#### Inherited from [#inherited-from-128]

`ImageSprite.percentageY`

***

### pivot [#pivot]

#### Get Signature [#get-signature-18]

\> **get** **pivot**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1023

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

##### Example [#example-75]

```ts
// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // Rotates around center
```

##### Since [#since-2]

4.0.0

##### Returns [#returns-36]

`ObservablePoint`

#### Set Signature [#set-signature-12]

\> **set** **pivot**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1024

##### Parameters [#parameters-14]

###### value [#value-10]

`number` | `PointData`

##### Returns [#returns-37]

`void`

#### Inherited from [#inherited-from-129]

`ImageSprite.pivot`

***

### position [#position]

#### Get Signature [#get-signature-19]

\> **get** **position**(): `ObservablePoint`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:800

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-76]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-3]

4.0.0

##### Returns [#returns-38]

`ObservablePoint`

#### Set Signature [#set-signature-13]

\> **set** **position**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:801

The coordinate of the object relative to the local coordinates of the parent.

##### Example [#example-77]

```ts
// Basic position setting
container.position.set(100, 200);
container.position.set(100); // Sets both x and y to 100
// Using point data
container.position = { x: 50, y: 75 };
```

##### Since [#since-4]

4.0.0

##### Parameters [#parameters-15]

###### value [#value-11]

`ObservablePoint`

##### Returns [#returns-39]

`void`

#### Inherited from [#inherited-from-130]

`ImageSprite.position`

***

### positionInfo [#positioninfo]

#### Get Signature [#get-signature-20]

\> **get** **positionInfo**(): `object`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:789

##### Returns [#returns-40]

`object`

###### type [#type]

\> **type**: `"align"` | `"pixel"` | `"percentage"`

###### x [#x]

\> **x**: `number`

###### y [#y]

\> **y**: `number`

#### Set Signature [#set-signature-14]

\> **set** **positionInfo**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:794

##### Parameters [#parameters-16]

###### value [#value-12]

###### type? [#type-1]

`"align"` | `"pixel"` | `"percentage"`

###### x [#x-1]

`number`

###### y [#y-1]

`number`

##### Returns [#returns-41]

`void`

#### Inherited from [#inherited-from-131]

`ImageSprite.positionInfo`

***

### positionType [#positiontype]

#### Get Signature [#get-signature-21]

\> **get** **positionType**(): `"align"` | `"pixel"` | `"percentage"`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:788

##### Returns [#returns-42]

`"align"` | `"pixel"` | `"percentage"`

#### Inherited from [#inherited-from-132]

`ImageSprite.positionType`

***

### renderable [#renderable]

#### Get Signature [#get-signature-22]

\> **get** **renderable**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1323

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

##### Example [#example-78]

```ts
// Basic render control
sprite.renderable = false; // Skip rendering
sprite.renderable = true;  // Enable rendering
```

##### Default [#default-54]

```ts
true
```

##### See [#see-19]

* Container#visible For skipping transform updates
* Container#alpha For transparency

##### Returns [#returns-43]

`boolean`

#### Set Signature [#set-signature-15]

\> **set** **renderable**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1324

##### Parameters [#parameters-17]

###### value [#value-13]

`boolean`

##### Returns [#returns-44]

`void`

#### Inherited from [#inherited-from-133]

`ImageSprite.renderable`

***

### rotation [#rotation]

#### Get Signature [#get-signature-23]

\> **get** **rotation**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:984

The rotation of the object in radians.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

##### Example [#example-79]

```ts
// Basic rotation
container.rotation = Math.PI / 4; // 45 degrees

// Convert from degrees
const degrees = 45;
container.rotation = degrees * Math.PI / 180;

// Rotate around center
container.pivot.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees

// Rotate around center with origin
container.origin.set(container.width / 2, container.height / 2);
container.rotation = Math.PI; // 180 degrees
```

##### Returns [#returns-45]

`number`

#### Set Signature [#set-signature-16]

\> **set** **rotation**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:985

##### Parameters [#parameters-18]

###### value [#value-14]

`number`

##### Returns [#returns-46]

`void`

#### Inherited from [#inherited-from-134]

`ImageSprite.rotation`

***

### roundPixels [#roundpixels]

#### Get Signature [#get-signature-24]

\> **get** **roundPixels**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:86

Whether or not to round the x/y position of the sprite.

##### Example [#example-80]

```ts
// Enable pixel rounding for crisp rendering
view.roundPixels = true;
```

##### Default [#default-55]

```ts
false
```

##### Returns [#returns-47]

`boolean`

#### Set Signature [#set-signature-17]

\> **set** **roundPixels**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:87

Whether or not to round the x/y position of the object.

##### Parameters [#parameters-19]

###### value [#value-15]

`boolean`

##### Returns [#returns-48]

`void`

#### Inherited from [#inherited-from-135]

`ImageSprite.roundPixels`

***

### scale [#scale]

#### Get Signature [#get-signature-25]

\> **get** **scale**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1071

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

##### Example [#example-81]

```ts
// Basic scaling
container.scale.set(2, 2); // Scales to double size
container.scale.set(2); // Scales uniformly to double size
container.scale = 2; // Scales uniformly to double size
// Scale to a specific width and height
container.setSize(200, 100); // Sets width to 200 and height to 100
```

##### Since [#since-5]

4.0.0

##### Returns [#returns-49]

`ObservablePoint`

#### Set Signature [#set-signature-18]

\> **set** **scale**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1072

##### Parameters [#parameters-20]

###### value [#value-16]

`string` | `number` | `PointData`

##### Returns [#returns-50]

`void`

#### Inherited from [#inherited-from-136]

`ImageSprite.scale`

***

### skew [#skew]

#### Get Signature [#get-signature-26]

\> **get** **skew**(): `ObservablePoint`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1054

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

##### Example [#example-82]

```ts
// Basic skewing
container.skew.set(0.5, 0); // Skew horizontally
container.skew.set(0, 0.5); // Skew vertically

// Skew with point data
container.skew = { x: 0.3, y: 0.3 }; // Diagonal skew

// Reset skew
container.skew.set(0, 0);

// Animate skew
app.ticker.add(() => {
    // Create wave effect
    container.skew.x = Math.sin(Date.now() / 1000) * 0.3;
});

// Combine with rotation
container.rotation = Math.PI / 4; // 45 degrees
container.skew.set(0.2, 0.2); // Skew the rotated object
```

##### Since [#since-6]

4.0.0

##### Default [#default-56]

```ts
{x: 0, y: 0}
```

##### Returns [#returns-51]

`ObservablePoint`

#### Set Signature [#set-signature-19]

\> **set** **skew**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1055

##### Parameters [#parameters-21]

###### value [#value-17]

`PointData`

##### Returns [#returns-52]

`void`

#### Inherited from [#inherited-from-137]

`ImageSprite.skew`

***

### texture [#texture]

#### Get Signature [#get-signature-27]

\> **get** **texture**(): `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:859

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-83]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-20]

* Texture For texture creation and management
* Assets For asset loading

##### Returns [#returns-53]

`Texture`\<`TextureSource`\<`any`>>

#### Set Signature [#set-signature-20]

\> **set** **texture**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:858

The texture that is displayed by the sprite. When changed, automatically updates
the sprite dimensions and manages texture event listeners.

##### Example [#example-84]

```ts
// Create sprite with texture
const sprite = new Sprite({
    texture: Texture.from('sprite.png')
});

// Update texture
sprite.texture = Texture.from('newSprite.png');

// Use texture from spritesheet
const sheet = await Assets.load('spritesheet.json');
sprite.texture = sheet.textures['frame1.png'];

// Reset to empty texture
sprite.texture = Texture.EMPTY;
```

##### See [#see-21]

* Texture For texture creation and management
* Assets For asset loading

##### Parameters [#parameters-22]

###### value [#value-18]

`Texture`\<`TextureSource`\<`any`>>

##### Returns [#returns-54]

`void`

#### Inherited from [#inherited-from-138]

`ImageSprite.texture`

***

### textureAlias [#texturealias]

#### Get Signature [#get-signature-28]

\> **get** `protected` **textureAlias**(): `string`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:841

##### Returns [#returns-55]

`string`

#### Inherited from [#inherited-from-139]

`ImageSprite.textureAlias`

***

### tint [#tint]

#### Get Signature [#get-signature-29]

\> **get** **tint**(): `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1268

The tint applied to the sprite.

This can be any valid ColorSource.

##### Example [#example-85]

```ts
// Basic color tinting
container.tint = 0xff0000; // Red tint
container.tint = 'red';    // Same as above
container.tint = '#00ff00'; // Green
container.tint = 'rgb(0,0,255)'; // Blue

// Remove tint
container.tint = 0xffffff; // White = no tint
container.tint = null;     // Also removes tint
```

##### Default [#default-57]

```ts
0xFFFFFF
```

##### See [#see-22]

* Container#alpha For transparency
* Container#visible For visibility control

##### Returns [#returns-56]

`number`

#### Set Signature [#set-signature-21]

\> **set** **tint**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1247

##### Parameters [#parameters-23]

###### value [#value-19]

`ColorSource`

##### Returns [#returns-57]

`void`

#### Inherited from [#inherited-from-140]

`ImageSprite.tint`

***

### visible [#visible]

#### Get Signature [#get-signature-30]

\> **get** **visible**(): `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1303

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

##### Example [#example-86]

```ts
// Basic visibility toggle
sprite.visible = false; // Hide sprite
sprite.visible = true;  // Show sprite
```

##### Default [#default-58]

```ts
true
```

##### See [#see-23]

* Container#renderable For render-only control
* Container#alpha For transparency

##### Returns [#returns-58]

`boolean`

#### Set Signature [#set-signature-22]

\> **set** **visible**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1304

##### Parameters [#parameters-24]

###### value [#value-20]

`boolean`

##### Returns [#returns-59]

`void`

#### Inherited from [#inherited-from-141]

`ImageSprite.visible`

***

### visualBounds [#visualbounds]

#### Get Signature [#get-signature-31]

\> **get** **visualBounds**(): `BoundsData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:205

The bounds of the sprite, taking into account the texture's trim area.

##### Example [#example-87]

````ts
const texture = new Texture({
    source: new TextureSource({ width: 300, height: 300 }),
    frame: new Rectangle(196, 66, 58, 56),
    trim: new Rectangle(4, 4, 58, 56),
    orig: new Rectangle(0, 0, 64, 64),
    rotate: 2,
});
const sprite = new Sprite(texture);
const visualBounds = sprite.visualBounds;
// console.log(visualBounds); // { minX: -4, maxX: 62, minY: -4, maxY: 60 }

##### Returns

`BoundsData`

#### Inherited from

`ImageSprite.visualBounds`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: node\_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:278

The width of the sprite, setting this will actually modify the scale to achieve the value set.

##### Example

```ts
// Set width directly
sprite.width = 200;
console.log(sprite.scale.x); // Scale adjusted to match width

// Set width while preserving aspect ratio
const ratio = sprite.height / sprite.width;
sprite.width = 300;
sprite.height = 300 * ratio;

// For better performance when setting both width and height
sprite.setSize(300, 400); // Avoids recalculating bounds twice

// Reset to original texture size
sprite.width = sprite.texture.orig.width;
````

##### Returns [#returns-60]

`number`

#### Set Signature [#set-signature-23]

> **set** **width**(`value`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:279

The width of the Container, setting this will actually modify the scale to achieve the value set.

> \[!NOTE] Changing the width will adjust the scale.x property of the container while maintaining its aspect ratio.
> \[!NOTE] If you want to set both width and height at the same time, use Container#setSize
> as it is more optimized by not recalculating the local bounds twice.

##### Example [#example-88]

```ts
// Basic width setting
container.width = 100;
// Optimized width setting
container.setSize(100, 100);
```

##### Parameters [#parameters-25]

###### value [#value-21]

`number`

##### Returns [#returns-61]

`void`

#### Inherited from [#inherited-from-142]

`ImageSprite.width`

***

### worldTransform [#worldtransform]

#### Get Signature [#get-signature-32]

> **get** **worldTransform**(): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:922

Current transform of the object based on world (parent) factors.

This matrix represents the absolute transformation in the scene graph.

##### Example [#example-89]

```ts
// Get world position
const worldPos = container.worldTransform;
console.log(`World position: (${worldPos.tx}, ${worldPos.ty})`);
```

##### See [#see-24]

Container#localTransform For local space transform

##### Returns [#returns-62]

`Matrix`

#### Inherited from [#inherited-from-143]

`ImageSprite.worldTransform`

***

### x [#x-2]

#### Get Signature [#get-signature-33]

> **get** **x**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:802

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-90]

```ts
// Basic position
container.x = 100;
```

##### Returns [#returns-63]

`number`

#### Set Signature [#set-signature-24]

> **set** **x**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:803

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

##### Example [#example-91]

```ts
// Basic position
container.x = 100;
```

##### Parameters [#parameters-26]

###### value [#value-22]

`number`

##### Returns [#returns-64]

`void`

#### Inherited from [#inherited-from-144]

`ImageSprite.x`

***

### xAlign [#xalign]

#### Get Signature [#get-signature-34]

> **get** **xAlign**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:778

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-65]

`number`

#### Set Signature [#set-signature-25]

> **set** **xAlign**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:777

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-27]

###### value [#value-23]

`number`

##### Returns [#returns-66]

`void`

#### Inherited from [#inherited-from-145]

`ImageSprite.xAlign`

***

### y [#y-2]

#### Get Signature [#get-signature-35]

> **get** **y**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:804

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-92]

```ts
// Basic position
container.y = 200;
```

##### Returns [#returns-67]

`number`

#### Set Signature [#set-signature-26]

> **set** **y**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:805

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

##### Example [#example-93]

```ts
// Basic position
container.y = 200;
```

##### Parameters [#parameters-28]

###### value [#value-24]

`number`

##### Returns [#returns-68]

`void`

#### Inherited from [#inherited-from-146]

`ImageSprite.y`

***

### yAlign [#yalign]

#### Get Signature [#get-signature-36]

> **get** **yAlign**(): `number`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:780

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Returns [#returns-69]

`number`

#### Set Signature [#set-signature-27]

> **set** **yAlign**(`value`): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:779

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

##### Parameters [#parameters-29]

###### value [#value-25]

`number`

##### Returns [#returns-70]

`void`

#### Inherited from [#inherited-from-147]

`ImageSprite.yAlign`

## Methods [#methods]

### \_getGlobalBoundsRecursive() [#_getglobalboundsrecursive]

> **\_getGlobalBoundsRecursive**(`factorRenderLayers`, `bounds`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:32

**`Internal`**

Recursively calculates the global bounds for the container and its children.
This method is used internally by getFastGlobalBounds to traverse the scene graph.

#### Parameters [#parameters-30]

##### factorRenderLayers [#factorrenderlayers]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds [#bounds-1]

`Bounds`

The bounds object to update with the calculated values.

##### currentLayer [#currentlayer]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-71]

`void`

#### Inherited from [#inherited-from-148]

`ImageSprite._getGlobalBoundsRecursive`

***

### \_onTouch()? [#_ontouch]

> `optional` **\_onTouch**(`now`): `void`

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/GCSystem.d.ts:31

An optional callback for when an item is touched

#### Parameters [#parameters-31]

##### now [#now]

`number`

#### Returns [#returns-72]

`void`

#### Inherited from [#inherited-from-149]

`ImageSprite._onTouch`

***

### addChild() [#addchild]

> **addChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:864

Adds one or more children to the container.
The children will be rendered as part of this container's display list.

#### Type Parameters [#type-parameters-1]

##### U [#u]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-32]

##### children [#children-1]

...`U`

The Container(s) to add to the container

#### Returns [#returns-73]

`U`\[`0`]

The first child that was added

#### Example [#example-94]

```ts
// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';
```

#### See [#see-25]

* Container#removeChild For removing children
* Container#addChildAt For adding at specific index

#### Inherited from [#inherited-from-150]

`ImageSprite.addChild`

***

### addChildAt() [#addchildat]

> **addChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:161

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown.
If the child is already in this container, it will be moved to the specified index.

When moving a child within the **same** container, `childAdded` and `added` events are
**not** emitted because the parent-child relationship hasn't changed. Events only fire when
a child is added from a different parent (or from no parent).

#### Type Parameters [#type-parameters-2]

##### U [#u-1]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-33]

##### child [#child]

`U`

The child to add

##### index [#index]

`number`

The index where the child will be placed

#### Returns [#returns-74]

`U`

The child that was added

#### Example [#example-95]

```ts
// Add at specific index
container.addChildAt(sprite, 0); // Add to front

// Move existing child (no events emitted)
const index = container.children.length - 1;
container.addChildAt(existingChild, index); // Move to back

// With error handling
try {
    container.addChildAt(sprite, 1000);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws]

If index is out of bounds

#### See [#see-26]

* Container#addChild For adding to the end
* Container#setChildIndex For moving existing children

#### Inherited from [#inherited-from-151]

`ImageSprite.addChildAt`

***

### addEventListener() [#addeventlistener]

#### Call Signature [#call-signature]

> **addEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1072

Unlike `on` or `addListener` which are methods from EventEmitter, `addEventListener`
seeks to be compatible with the DOM's `addEventListener` with support for options.

##### Type Parameters [#type-parameters-3]

###### K [#k]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-34]

###### type [#type-2]

`K`

The type of event to listen to.

###### listener [#listener]

(`e`) => `any`

The listener callback or object.

###### options? [#options-1]

`AddListenerOptions`

Listener options, used for capture phase.

##### Returns [#returns-75]

`void`

##### Example [#example-96]

```ts
// Tell the user whether they did a single, double, triple, or nth click.
button.addEventListener('click', {
    handleEvent(e): {
        let prefix;

        switch (e.detail) {
            case 1: prefix = 'single'; break;
            case 2: prefix = 'double'; break;
            case 3: prefix = 'triple'; break;
            default: prefix = e.detail + 'th'; break;
        }

        console.log('That was a ' + prefix + 'click');
    }
});

// But skip the first click!
button.parent.addEventListener('click', function blockClickOnce(e) {
    e.stopImmediatePropagation();
    button.parent.removeEventListener('click', blockClickOnce, true);
}, {
    capture: true,
});
```

##### Inherited from [#inherited-from-152]

`ImageSprite.addEventListener`

#### Call Signature [#call-signature-1]

> **addEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1073

##### Parameters [#parameters-35]

###### type [#type-3]

`string`

###### listener [#listener-1]

`EventListenerOrEventListenerObject`

###### options? [#options-2]

`AddListenerOptions`

##### Returns [#returns-76]

`void`

##### Inherited from [#inherited-from-153]

`ImageSprite.addEventListener`

***

### addListener() [#addlistener]

> **addListener**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:45

#### Type Parameters [#type-parameters-4]

##### T [#t]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-36]

##### event [#event]

`T`

##### fn [#fn]

(...`args`) => `void`

##### context? [#context]

`any`

#### Returns [#returns-77]

`this`

#### Inherited from [#inherited-from-154]

`ImageSprite.addListener`

***

### collectRenderables() [#collectrenderables]

> **collectRenderables**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:21

**`Internal`**

Collects all renderables from the container and its children, adding them to the instruction set.
This method decides whether to use a simple or advanced collection method based on the container's properties.

#### Parameters [#parameters-37]

##### instructionSet [#instructionset]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-1]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-78]

`void`

#### Inherited from [#inherited-from-155]

`ImageSprite.collectRenderables`

***

### collectRenderablesSimple() [#collectrenderablessimple]

> **collectRenderablesSimple**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:119

**`Internal`**

Collects renderables for the view container.

#### Parameters [#parameters-38]

##### instructionSet [#instructionset-1]

`InstructionSet`

The instruction set to collect renderables for.

##### renderer [#renderer-1]

`Renderer`

The renderer to collect renderables for.

##### currentLayer [#currentlayer-2]

`RenderLayer`

The current render layer.

#### Returns [#returns-79]

`void`

#### Inherited from [#inherited-from-156]

`ImageSprite.collectRenderablesSimple`

***

### collectRenderablesWithEffects() [#collectrenderableswitheffects]

> **collectRenderablesWithEffects**(`instructionSet`, `renderer`, `currentLayer`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/collectRenderablesMixin.d.ts:39

**`Internal`**

Collects renderables using an advanced method, suitable for containers with complex processing needs.
This method handles additional effects and transformations that may be applied to the renderables.

#### Parameters [#parameters-39]

##### instructionSet [#instructionset-2]

`InstructionSet`

The set of instructions to which the renderables will be added.

##### renderer [#renderer-2]

`Renderer`

The renderer responsible for rendering the scene.

##### currentLayer [#currentlayer-3]

`RenderLayer`

The current render layer being processed.

#### Returns [#returns-80]

`void`

#### Inherited from [#inherited-from-157]

`ImageSprite.collectRenderablesWithEffects`

***

### containsPoint() [#containspoint]

> **containsPoint**(`point`): `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:104

Checks if the object contains the given point in local coordinates.
Uses the view's bounds for hit testing.

#### Parameters [#parameters-40]

##### point [#point]

`PointData`

The point to check in local coordinates

#### Returns [#returns-81]

`boolean`

True if the point is within the view's bounds

#### Example [#example-97]

```ts
// Basic point check
const localPoint = { x: 50, y: 25 };
const contains = view.containsPoint(localPoint);
console.log('Point is inside:', contains);
```

#### See [#see-27]

* ViewContainer#bounds For the bounds used in hit testing
* [Container#toLocal](#tolocal) For converting global coordinates to local

#### Inherited from [#inherited-from-158]

`ImageSprite.containsPoint`

***

### destroy() [#destroy]

> **destroy**(`options?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

#### Parameters [#parameters-41]

##### options? [#options-3]

`DestroyOptions`

Options parameter. A boolean will act as if all options
have been set to that value

#### Returns [#returns-82]

`void`

#### Example [#example-98]

```ts
sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });
```

#### Inherited from [#inherited-from-159]

`ImageSprite.destroy`

***

### disableRenderGroup() [#disablerendergroup]

> **disableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:906

This will disable the render group for this container.

#### Returns [#returns-83]

`void`

#### Advanced [#advanced-9]

#### Inherited from [#inherited-from-160]

`ImageSprite.disableRenderGroup`

***

### dispatchEvent() [#dispatchevent]

> **dispatchEvent**(`e`): `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1094

Dispatch the event on this Container using the event's EventBoundary.

The target of the event is set to `this` and the `defaultPrevented` flag is cleared before dispatch.

#### Parameters [#parameters-42]

##### e [#e]

`FederatedEvent`

The event to dispatch.

#### Returns [#returns-84]

`boolean`

Whether the FederatedEvent.preventDefault preventDefault() method was not invoked.

#### Example [#example-99]

```ts
// Reuse a click event!
button.dispatchEvent(clickEvent);
```

#### Inherited from [#inherited-from-161]

`ImageSprite.dispatchEvent`

***

### emit() [#emit]

> **emit**\<`T`>(`event`, ...`args`): `boolean`

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

#### Type Parameters [#type-parameters-5]

##### T [#t-1]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-43]

##### event [#event-1]

`T`

##### args [#args]

...`ArgumentMap`\<`ContainerEvents`\<`ContainerChild`> & `AnyEvent`>\[`Extract`\<`T`, keyof ContainerEvents\<ContainerChild> | keyof AnyEvent>]

#### Returns [#returns-85]

`boolean`

#### Inherited from [#inherited-from-162]

`ImageSprite.emit`

***

### enableRenderGroup() [#enablerendergroup]

> **enableRenderGroup**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:901

Calling this enables a render group for this container.
This means it will be rendered as a separate set of instructions.
The transform of the container will also be handled on the GPU rather than the CPU.

#### Returns [#returns-86]

`void`

#### Advanced [#advanced-10]

#### Inherited from [#inherited-from-163]

`ImageSprite.enableRenderGroup`

***

### eventNames() [#eventnames]

> **eventNames**(): (keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered
listeners.

#### Returns [#returns-87]

(keyof ContainerEvents\<ContainerChild> | keyof AnyEvent)\[]

#### Inherited from [#inherited-from-164]

`ImageSprite.eventNames`

***

### getBounds() [#getbounds]

> **getBounds**(`skipUpdate?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:88

Calculates and returns the (world) bounds of the display object as a Rectangle.
Takes into account transforms and child bounds.

#### Parameters [#parameters-44]

##### skipUpdate? [#skipupdate]

`boolean`

Setting to `true` will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost.

##### bounds? [#bounds-2]

`Bounds`

Optional bounds to store the result of the bounds calculation

#### Returns [#returns-88]

`Bounds`

The minimum axis-aligned rectangle in world space that fits around this object

#### Example [#example-100]

```ts
// Basic bounds calculation
const bounds = sprite.getBounds();
console.log(`World bounds: ${bounds.x}, ${bounds.y}, ${bounds.width}, ${bounds.height}`);

// Reuse bounds object for performance
const recycleBounds = new Bounds();
sprite.getBounds(false, recycleBounds);

// Skip update for performance
const fastBounds = sprite.getBounds(true);
```

#### Remarks [#remarks-7]

* Includes transform calculations
* Updates scene graph by default
* Can reuse bounds objects
* Common in hit testing

#### See [#see-28]

* [Container#getLocalBounds](#getlocalbounds) For untransformed bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-165]

`ImageSprite.getBounds`

***

### getChildAt() [#getchildat]

> **getChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:85

Returns the child at the specified index.

#### Type Parameters [#type-parameters-6]

##### U [#u-2]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-45]

##### index [#index-1]

`number`

The index to get the child from

#### Returns [#returns-89]

`U`

The child at the given index

#### Example [#example-101]

```ts
// Get first child
const first = container.getChildAt(0);

// Type-safe access
const sprite = container.getChildAt<Sprite>(1);

// With error handling
try {
    const child = container.getChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-1]

If index is out of bounds

#### See [#see-29]

* Container#children For direct array access
* Container#getChildByLabel For name-based lookup

#### Inherited from [#inherited-from-166]

`ImageSprite.getChildAt`

***

### getChildByLabel() [#getchildbylabel]

> **getChildByLabel**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:53

Returns the first child in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-46]

##### label [#label-1]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep]

`boolean`

Whether to search recursively through children

#### Returns [#returns-90]

`Container`\<`ContainerChild`> | `null`

The first child with the specified label, or null if none found

#### Example [#example-102]

```ts
// Basic label search
const child = container.getChildByLabel('player');

// Search with regular expression
const enemy = container.getChildByLabel(/enemy-\d+/);

// Deep search through children
const deepChild = container.getChildByLabel('powerup', true);
```

#### See [#see-30]

* Container#getChildrenByLabel For finding all matches
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-167]

`ImageSprite.getChildByLabel`

***

### ~~getChildByName()~~ [#getchildbyname]

> **getChildByName**(`label`, `deep?`): `Container`\<`ContainerChild`> | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:32

#### Parameters [#parameters-47]

##### label [#label-2]

`string` | `RegExp`

Instance name.

##### deep? [#deep-1]

`boolean`

Whether to search recursively

#### Returns [#returns-91]

`Container`\<`ContainerChild`> | `null`

The child with the specified name.

#### Deprecated [#deprecated-2]

since 8.0.0

#### See [#see-31]

Container#getChildByLabel

#### Inherited from [#inherited-from-168]

`ImageSprite.getChildByName`

***

### getChildIndex() [#getchildindex]

> **getChildIndex**(`child`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:130

Returns the index position of a child Container instance.

#### Parameters [#parameters-48]

##### child [#child-1]

`ContainerChild`

The Container instance to identify

#### Returns [#returns-92]

`number`

The index position of the child container

#### Example [#example-103]

```ts
// Basic index lookup
const index = container.getChildIndex(sprite);
console.log(`Sprite is at index ${index}`);

// With error handling
try {
    const index = container.getChildIndex(sprite);
} catch (e) {
    console.warn('Child not found in container');
}
```

#### Throws [#throws-2]

If child is not in this container

#### See [#see-32]

* Container#setChildIndex For changing index
* Container#children For direct array access

#### Inherited from [#inherited-from-169]

`ImageSprite.getChildIndex`

***

### getChildrenByLabel() [#getchildrenbylabel]

> **getChildrenByLabel**(`label`, `deep?`, `out?`): `Container`\<`ContainerChild`>\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:74

Returns all children in the container with the specified label.
Recursive searches are done in a pre-order traversal.

#### Parameters [#parameters-49]

##### label [#label-3]

`string` | `RegExp`

Instance label to search for

##### deep? [#deep-2]

`boolean`

Whether to search recursively through children

##### out? [#out]

`Container`\<`ContainerChild`>\[]

Optional array to store matching children in

#### Returns [#returns-93]

`Container`\<`ContainerChild`>\[]

An array of children with the specified label

#### Example [#example-104]

```ts
// Basic label search
const enemies = container.getChildrenByLabel('enemy');
// Search with regular expression
const powerups = container.getChildrenByLabel(/powerup-\d+/);
// Deep search with collection
const buttons = [];
container.getChildrenByLabel('button', true, buttons);
```

#### See [#see-33]

* Container#getChildByLabel For finding first match
* [Container#label](#label) For setting labels

#### Inherited from [#inherited-from-170]

`ImageSprite.getChildrenByLabel`

***

### getFastGlobalBounds() [#getfastglobalbounds]

> **getFastGlobalBounds**(`factorRenderLayers?`, `bounds?`): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getFastGlobalBoundsMixin.d.ts:23

Computes an approximate global bounding box for the container and its children.
This method is optimized for speed by using axis-aligned bounding boxes (AABBs),
and uses the last render results from when it updated the transforms. This function does not update them.
which may result in slightly larger bounds but never smaller than the actual bounds.

for accurate (but less performant) results use `container.getGlobalBounds`

#### Parameters [#parameters-50]

##### factorRenderLayers? [#factorrenderlayers-1]

`boolean`

A flag indicating whether to consider render layers in the calculation.

##### bounds? [#bounds-3]

`Bounds`

The output bounds object to store the result. If not provided, a new one is created.

#### Returns [#returns-94]

`Bounds`

The computed bounds.

#### Advanced [#advanced-11]

#### Inherited from [#inherited-from-171]

`ImageSprite.getFastGlobalBounds`

***

### getGlobalAlpha() [#getglobalalpha]

> **getGlobalAlpha**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:35

Returns the global (compound) alpha of the container within the scene.

#### Parameters [#parameters-51]

##### skipUpdate? [#skipupdate-1]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire alpha chain through parents for accuracy
* If true: Uses cached worldAlpha from the last render pass for better performance

#### Returns [#returns-95]

`number`

The resulting alpha value (between 0 and 1)

#### Example [#example-105]

```ts
// Accurate but slower - recalculates entire alpha chain
const preciseAlpha = container.getGlobalAlpha();

// Faster but may be outdated - uses cached alpha
const cachedAlpha = container.getGlobalAlpha(true);
```

#### Inherited from [#inherited-from-172]

`ImageSprite.getGlobalAlpha`

***

### getGlobalPosition() [#getglobalposition]

> **getGlobalPosition**(`point?`, `skipUpdate?`): `Point`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:36

Returns the global position of the container, taking into account the container hierarchy.

#### Parameters [#parameters-52]

##### point? [#point-1]

`Point`

The optional point to write the global value to

##### skipUpdate? [#skipupdate-2]

`boolean`

Should we skip the update transform

#### Returns [#returns-96]

`Point`

The updated point

#### Example [#example-106]

```ts
// Basic position check
const globalPos = sprite.getGlobalPosition();
console.log(`Global: (${globalPos.x}, ${globalPos.y})`);

// Reuse point object
const point = new Point();
sprite.getGlobalPosition(point);

// Skip transform update for performance
const fastPos = container.getGlobalPosition(undefined, true);
```

#### See [#see-34]

* [Container#toGlobal](#toglobal) For converting specific points
* [Container#toLocal](#tolocal) For converting to local space

#### Inherited from [#inherited-from-173]

`ImageSprite.getGlobalPosition`

***

### getGlobalTint() [#getglobaltint]

> **getGlobalTint**(`skipUpdate?`): `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:72

Returns the global (compound) tint color of the container within the scene.

#### Parameters [#parameters-53]

##### skipUpdate? [#skipupdate-3]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire tint chain through parents for accuracy
* If true: Uses cached worldColor from the last render pass for better performance

#### Returns [#returns-97]

`number`

The resulting tint color as a 24-bit RGB number (0xRRGGBB)

#### Example [#example-107]

```ts
// Accurate but slower - recalculates entire tint chain
const preciseTint = container.getGlobalTint();

// Faster but may be outdated - uses cached tint
const cachedTint = container.getGlobalTint(true);
```

#### Inherited from [#inherited-from-174]

`ImageSprite.getGlobalTint`

***

### getGlobalTransform() [#getglobaltransform]

> **getGlobalTransform**(`matrix?`, `skipUpdate?`): `Matrix`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/getGlobalMixin.d.ts:56

Returns the global transform matrix of the container within the scene.

#### Parameters [#parameters-54]

##### matrix? [#matrix]

`Matrix`

Optional matrix to store the result. If not provided, a new Matrix will be created.

##### skipUpdate? [#skipupdate-4]

`boolean`

Performance optimization flag:

* If false (default): Recalculates the entire transform chain for accuracy
* If true: Uses cached worldTransform from the last render pass for better performance

#### Returns [#returns-98]

`Matrix`

The resulting transformation matrix (either the input matrix or a new one)

#### Example [#example-108]

```ts
// Accurate but slower - recalculates entire transform chain
const preciseTransform = container.getGlobalTransform();

// Faster but may be outdated - uses cached transform
const cachedTransform = container.getGlobalTransform(undefined, true);

// Reuse existing matrix
const existingMatrix = new Matrix();
container.getGlobalTransform(existingMatrix);
```

#### Inherited from [#inherited-from-175]

`ImageSprite.getGlobalTransform`

***

### getLocalBounds() [#getlocalbounds]

> **getLocalBounds**(): `Bounds`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:58

Retrieves the local bounds of the container as a Bounds object.
Uses cached values when possible for better performance.

#### Returns [#returns-99]

`Bounds`

The bounding area

#### Example [#example-109]

```ts
// Basic bounds check
const bounds = container.getLocalBounds();
console.log(`Width: ${bounds.width}, Height: ${bounds.height}`);
// subsequent calls will reuse the cached bounds
const cachedBounds = container.getLocalBounds();
console.log(bounds === cachedBounds); // true
```

#### See [#see-35]

* [Container#getBounds](#getbounds) For world space bounds
* Bounds For bounds properties

#### Inherited from [#inherited-from-176]

`ImageSprite.getLocalBounds`

***

### getSize() [#getsize]

> **getSize**(`out?`): `Size`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:322

Retrieves the size of the Sprite as a \[Size]Size object based on the texture dimensions and scale.
This is faster than getting width and height separately as it only calculates the bounds once.

#### Parameters [#parameters-55]

##### out? [#out-1]

`Size`

Optional object to store the size in, to avoid allocating a new object

#### Returns [#returns-100]

`Size`

The size of the Sprite

#### Example [#example-110]

```ts
// Basic size retrieval
const sprite = new Sprite(Texture.from('sprite.png'));
const size = sprite.getSize();
console.log(`Size: ${size.width}x${size.height}`);

// Reuse existing size object
const reuseSize = { width: 0, height: 0 };
sprite.getSize(reuseSize);
```

#### See [#see-36]

* Sprite#width For getting just the width
* Sprite#height For getting just the height
* Sprite#setSize For setting both width and height

#### Inherited from [#inherited-from-177]

`ImageSprite.getSize`

***

### listenerCount() [#listenercount]

> **listenerCount**(`event`): `number`

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

#### Parameters [#parameters-56]

##### event [#event-2]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-101]

`number`

#### Inherited from [#inherited-from-178]

`ImageSprite.listenerCount`

***

### listeners() [#listeners]

> **listeners**\<`T`>(`event`): (...`args`) => `void`\[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

#### Type Parameters [#type-parameters-7]

##### T [#t-2]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-57]

##### event [#event-3]

`T`

#### Returns [#returns-102]

(...`args`) => `void`\[]

#### Inherited from [#inherited-from-179]

`ImageSprite.listeners`

***

### load() [#load]

> **load**(): `Promise`\<`void`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:857

Load the image from the link and set the texture of the sprite.

#### Returns [#returns-103]

`Promise`\<`void`>

A promise that resolves when the image is loaded.

#### Inherited from [#inherited-from-180]

`ImageSprite.load`

***

### off() [#off]

> **off**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:69

#### Type Parameters [#type-parameters-8]

##### T [#t-3]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-58]

##### event [#event-4]

`T`

##### fn? [#fn-1]

(...`args`) => `void`

##### context? [#context-1]

`any`

##### once? [#once]

`boolean`

#### Returns [#returns-104]

`this`

#### Inherited from [#inherited-from-181]

`ImageSprite.off`

***

### on() [#on]

> **on**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:760

Add a listener for a given event.

#### Type Parameters [#type-parameters-9]

##### T [#t-4]

`T` *extends* `symbol` | `object` & `string` | keyof ContainerEvents\<ContainerChild>

#### Parameters [#parameters-59]

##### event [#event-5]

`T`

##### fn [#fn-2]

(...`args`) => `void`

##### context? [#context-2]

`any`

#### Returns [#returns-105]

`this`

#### Inherited from [#inherited-from-182]

`ImageSprite.on`

***

### once() [#once-1]

> **once**\<`T`>(`event`, `fn`, `context?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

#### Type Parameters [#type-parameters-10]

##### T [#t-5]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-60]

##### event [#event-6]

`T`

##### fn [#fn-3]

(...`args`) => `void`

##### context? [#context-3]

`any`

#### Returns [#returns-106]

`this`

#### Inherited from [#inherited-from-183]

`ImageSprite.once`

***

### reloadPosition() [#reloadposition]

> `protected` **reloadPosition**(): `void`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:799

#### Returns [#returns-107]

`void`

#### Inherited from [#inherited-from-184]

`ImageSprite.reloadPosition`

***

### removeAllListeners() [#removealllisteners]

> **removeAllListeners**(`event?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

#### Parameters [#parameters-61]

##### event? [#event-7]

keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Returns [#returns-108]

`this`

#### Inherited from [#inherited-from-185]

`ImageSprite.removeAllListeners`

***

### removeChild() [#removechild]

> **removeChild**\<`U`>(...`children`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:885

Removes one or more children from the container.
When removing multiple children, events will be triggered for each child in sequence.

#### Type Parameters [#type-parameters-11]

##### U [#u-3]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-62]

##### children [#children-2]

...`U`

The Container(s) to remove

#### Returns [#returns-109]

`U`\[`0`]

The first child that was removed

#### Example [#example-111]

```ts
// Remove a single child
const removed = container.removeChild(sprite);

// Remove multiple children
const bg = container.removeChild(background, player, userInterface);

// Remove with type checking
const sprite = container.removeChild<Sprite>(childSprite);
sprite.texture = newTexture;
```

#### See [#see-37]

* Container#addChild For adding children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-186]

`ImageSprite.removeChild`

***

### removeChildAt() [#removechildat]

> **removeChildAt**\<`U`>(`index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:61

Removes a child from the specified index position.

#### Type Parameters [#type-parameters-12]

##### U [#u-4]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-63]

##### index [#index-2]

`number`

The index to remove the child from

#### Returns [#returns-110]

`U`

The child that was removed

#### Example [#example-112]

```ts
// Remove first child
const removed = container.removeChildAt(0);

// type safe access
const sprite = container.removeChildAt<Sprite>(1);

// With error handling
try {
    const child = container.removeChildAt(10);
} catch (e) {
    console.warn('Index out of bounds');
}
```

#### Throws [#throws-3]

If index is out of bounds

#### See [#see-38]

* Container#removeChild For removing specific children
* Container#removeChildren For removing multiple children

#### Inherited from [#inherited-from-187]

`ImageSprite.removeChildAt`

***

### removeChildren() [#removechildren]

> **removeChildren**(`beginIndex?`, `endIndex?`): `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:37

Removes all children from this container that are within the begin and end indexes.

#### Parameters [#parameters-64]

##### beginIndex? [#beginindex]

`number`

The beginning position

##### endIndex? [#endindex]

`number`

The ending position. Default is container size

#### Returns [#returns-111]

`ContainerChild`\[]

List of removed children

#### Example [#example-113]

```ts
// Remove all children
container.removeChildren();

// Remove first 3 children
const removed = container.removeChildren(0, 3);
console.log('Removed:', removed.length); // 3

// Remove children from index 2 onwards
container.removeChildren(2);

// Remove specific range
const middle = container.removeChildren(1, 4);
```

#### Throws [#throws-4]

If begin/end indexes are invalid

#### See [#see-39]

* Container#addChild For adding children
* Container#removeChild For removing specific children

#### Inherited from [#inherited-from-188]

`ImageSprite.removeChildren`

***

### removeEventListener() [#removeeventlistener]

#### Call Signature [#call-signature-2]

> **removeEventListener**\<`K`>(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1082

Unlike `off` or `removeListener` which are methods from EventEmitter, `removeEventListener`
seeks to be compatible with the DOM's `removeEventListener` with support for options.

##### Type Parameters [#type-parameters-13]

###### K [#k-1]

`K` *extends* keyof FederatedEventMap | keyof GlobalFederatedEventMap

##### Parameters [#parameters-65]

###### type [#type-4]

`K`

The type of event the listener is bound to.

###### listener [#listener-2]

(`e`) => `any`

The listener callback or object.

###### options? [#options-4]

`RemoveListenerOptions`

The original listener options.
This is required to deregister a capture phase listener.

##### Returns [#returns-112]

`void`

##### Inherited from [#inherited-from-189]

`ImageSprite.removeEventListener`

#### Call Signature [#call-signature-3]

> **removeEventListener**(`type`, `listener`, `options?`): `void`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:1083

##### Parameters [#parameters-66]

###### type [#type-5]

`string`

###### listener [#listener-3]

`EventListenerOrEventListenerObject`

###### options? [#options-5]

`RemoveListenerOptions`

##### Returns [#returns-113]

`void`

##### Inherited from [#inherited-from-190]

`ImageSprite.removeEventListener`

***

### removeFromParent() [#removefromparent]

> **removeFromParent**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:203

Remove the Container from its parent Container. If the Container has no parent, do nothing.

#### Returns [#returns-114]

`void`

#### Example [#example-114]

```ts
// Basic removal
sprite.removeFromParent();

// With validation
if (sprite.parent) {
    sprite.removeFromParent();
}
```

#### See [#see-40]

* Container#addChild For adding to a new parent
* Container#removeChild For parent removing children

#### Inherited from [#inherited-from-191]

`ImageSprite.removeFromParent`

***

### removeListener() [#removelistener]

> **removeListener**\<`T`>(`event`, `fn?`, `context?`, `once?`): `this`

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

#### Type Parameters [#type-parameters-14]

##### T [#t-6]

`T` *extends* keyof ContainerEvents\<ContainerChild> | keyof AnyEvent

#### Parameters [#parameters-67]

##### event [#event-8]

`T`

##### fn? [#fn-4]

(...`args`) => `void`

##### context? [#context-4]

`any`

##### once? [#once-2]

`boolean`

#### Returns [#returns-115]

`this`

#### Inherited from [#inherited-from-192]

`ImageSprite.removeListener`

***

### reparentChild() [#reparentchild]

> **reparentChild**\<`U`>(...`child`): `U`\[`0`]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:224

Reparent a child or multiple children to this container while preserving their world transform.
This ensures that the visual position and rotation of the children remain the same even when changing parents.

#### Type Parameters [#type-parameters-15]

##### U [#u-5]

`U` *extends* `ContainerChild`\[]

#### Parameters [#parameters-68]

##### child [#child-2]

...`U`

The child or children to reparent

#### Returns [#returns-116]

`U`\[`0`]

The first child that was reparented

#### Example [#example-115]

```ts
// Basic reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent, keeping visual position
newContainer.reparentChild(sprite);

// Reparent multiple children
const batch = [sprite1, sprite2, sprite3];
newContainer.reparentChild(...batch);
```

#### See [#see-41]

* Container#reparentChildAt For index-specific reparenting
* Container#addChild For simple parenting

#### Inherited from [#inherited-from-193]

`ImageSprite.reparentChild`

***

### reparentChildAt() [#reparentchildat]

> **reparentChildAt**\<`U`>(`child`, `index`): `U`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:243

Reparent the child to this container at the specified index while preserving its world transform.
This ensures that the visual position and rotation of the child remain the same even when changing parents.

#### Type Parameters [#type-parameters-16]

##### U [#u-6]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-69]

##### child [#child-3]

`U`

The child to reparent

##### index [#index-3]

`number`

The index to reparent the child to

#### Returns [#returns-117]

`U`

The reparented child

#### Example [#example-116]

```ts
// Basic index-specific reparenting
const sprite = new Sprite(texture);
oldContainer.addChild(sprite);
// Move to new parent at index 0 (front)
newContainer.reparentChildAt(sprite, 0);
```

#### Throws [#throws-5]

If index is out of bounds

#### See [#see-42]

* Container#reparentChild For appending reparented children
* Container#addChildAt For simple indexed parenting

#### Inherited from [#inherited-from-194]

`ImageSprite.reparentChildAt`

***

### replaceChild() [#replacechild]

> **replaceChild**\<`U`, `T`>(`oldChild`, `newChild`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:249

Replace a child in the container with a new child. Copying the local transform from the old child to the new one.

#### Type Parameters [#type-parameters-17]

##### U [#u-7]

`U` *extends* `ContainerChild`

##### T [#t-7]

`T` *extends* `ContainerChild`

#### Parameters [#parameters-70]

##### oldChild [#oldchild]

`U`

The child to replace.

##### newChild [#newchild]

`T`

The new child to add.

#### Returns [#returns-118]

`void`

#### Inherited from [#inherited-from-195]

`ImageSprite.replaceChild`

***

### setChildIndex() [#setchildindex]

> **setChildIndex**(`child`, `index`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:108

Changes the position of an existing child in the container.

#### Parameters [#parameters-71]

##### child [#child-4]

`ContainerChild`

The child Container instance to reposition

##### index [#index-4]

`number`

The resulting index number for the child

#### Returns [#returns-119]

`void`

#### Example [#example-117]

```ts
// Basic index change
container.setChildIndex(sprite, 0); // Move to front
container.setChildIndex(sprite, container.children.length - 1); // Move to back

// With error handling
try {
    container.setChildIndex(sprite, 5);
} catch (e) {
    console.warn('Invalid index or child not found');
}
```

#### Throws [#throws-6]

If index is out of bounds

#### Throws [#throws-7]

If child is not in container

#### See [#see-43]

* Container#getChildIndex For getting current index
* Container#swapChildren For swapping positions

#### Inherited from [#inherited-from-196]

`ImageSprite.setChildIndex`

***

### setFromMatrix() [#setfrommatrix]

> **setFromMatrix**(`matrix`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1223

Updates the local transform properties by decomposing the given matrix.
Extracts position, scale, rotation, and skew from a transformation matrix.

#### Parameters [#parameters-72]

##### matrix [#matrix-1]

`Matrix`

The matrix to use for updating the transform

#### Returns [#returns-120]

`void`

#### Example [#example-118]

```ts
// Basic matrix transform
const matrix = new Matrix()
    .translate(100, 100)
    .rotate(Math.PI / 4)
    .scale(2, 2);

container.setFromMatrix(matrix);

// Copy transform from another container
const source = new Container();
source.position.set(100, 100);
source.rotation = Math.PI / 2;

target.setFromMatrix(source.localTransform);

// Reset transform
container.setFromMatrix(Matrix.IDENTITY);
```

#### See [#see-44]

* Container#updateTransform For property-based updates
* Matrix#decompose For matrix decomposition details

#### Inherited from [#inherited-from-197]

`ImageSprite.setFromMatrix`

***

### setMask() [#setmask]

> **setMask**(`options`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:229

Used to set mask and control mask options on a display object.
Allows for more detailed control over masking behavior compared to the mask property.

#### Parameters [#parameters-73]

##### options [#options-6]

`Partial`\<`MaskOptionsAndMask`>

Configuration options for the mask

#### Returns [#returns-121]

`void`

#### Example [#example-119]

```ts
import { Graphics, Sprite } from 'pixi.js';

// Create a circular mask
const graphics = new Graphics()
    .beginFill(0xFF3300)
    .drawCircle(100, 100, 50)
    .endFill();

// Apply mask with options
sprite.setMask({
    mask: graphics,
    inverse: true, // Create a hole effect
});

// Use the alpha channel for masking (useful for sprites with transparency)
sprite.setMask({
    mask: maskSprite,
    channel: 'alpha',
});

// Clear existing mask
sprite.setMask({ mask: null });
```

#### See [#see-45]

* [Container#mask](#mask) For simple masking
* MaskOptionsAndMask For full options API
* MaskOptions#channel For channel selection

#### Inherited from [#inherited-from-198]

`ImageSprite.setMask`

***

### setMemory() [#setmemory]

> **setMemory**(`memory`): `Promise`\<`void`>

Defined in: [src/canvas/AIImageSprite.ts:69](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L69)

#### Parameters [#parameters-74]

##### memory [#memory-2]

`ImageSpriteMemory` | `Memory`

#### Returns [#returns-122]

`Promise`\<`void`>

#### Overrides [#overrides-3]

`ImageSprite.setMemory`

***

### setSize() [#setsize]

> **setSize**(`value`, `height?`): `void`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:353

Sets the size of the Sprite to the specified width and height.
This is faster than setting width and height separately as it only recalculates bounds once.

#### Parameters [#parameters-75]

##### value [#value-26]

`number` | `Optional`\<`Size`, `"height"`>

This can be either a number or a Size object

##### height? [#height-1]

`number`

The height to set. Defaults to the value of `width` if not provided

#### Returns [#returns-123]

`void`

#### Example [#example-120]

```ts
// Basic size setting
const sprite = new Sprite(Texture.from('sprite.png'));
sprite.setSize(100, 200); // Width: 100, Height: 200

// Set uniform size
sprite.setSize(100); // Sets both width and height to 100

// Set size with object
sprite.setSize({
    width: 200,
    height: 300
});

// Reset to texture size
sprite.setSize(
    sprite.texture.orig.width,
    sprite.texture.orig.height
);
```

#### See [#see-46]

* Sprite#width For setting width only
* Sprite#height For setting height only
* Sprite#texture For the source dimensions

#### Inherited from [#inherited-from-199]

`ImageSprite.setSize`

***

### swapChildren() [#swapchildren]

> **swapChildren**\<`U`>(`child`, `child2`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/childrenHelperMixin.d.ts:187

Swaps the position of 2 Containers within this container.

#### Type Parameters [#type-parameters-18]

##### U [#u-8]

`U` *extends* `ContainerChild`

#### Parameters [#parameters-76]

##### child [#child-5]

`U`

First container to swap

##### child2 [#child2]

`U`

Second container to swap

#### Returns [#returns-124]

`void`

#### Example [#example-121]

```ts
// Basic swap
container.swapChildren(sprite1, sprite2);

// With error handling
try {
    container.swapChildren(sprite1, sprite2);
} catch (e) {
    console.warn('One or both children not found in container');
}
```

#### Remarks [#remarks-8]

* Updates render groups
* No effect if same child
* Triggers container changes
* Common in z-ordering

#### Throws [#throws-8]

If either child is not in container

#### See [#see-47]

* Container#setChildIndex For direct index placement
* Container#getChildIndex For getting current positions

#### Inherited from [#inherited-from-200]

`ImageSprite.swapChildren`

***

### toGlobal() [#toglobal]

> **toGlobal**\<`P`>(`position`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:64

Calculates the global position of a point relative to this container.
Takes into account the container hierarchy and transforms.

#### Type Parameters [#type-parameters-19]

##### P [#p]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-77]

##### position [#position-1]

`PointData`

The local point to convert

##### point? [#point-2]

`P`

Optional point to store the result

##### skipUpdate? [#skipupdate-5]

`boolean`

Whether to skip transform updates

#### Returns [#returns-125]

`P`

The global position

#### Example [#example-122]

```ts
// Basic point conversion
const localPoint = { x: 10, y: 20 };
const globalPoint = container.toGlobal(localPoint);

// With point reuse
const reusePoint = new Point();
container.toGlobal(localPoint, reusePoint);

// Performance optimization
const fastPoint = container.toGlobal(
    { x: 50, y: 50 },
    undefined,
    true // Skip transform update
);
```

#### See [#see-48]

* [Container#toLocal](#tolocal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-201]

`ImageSprite.toGlobal`

***

### toLocal() [#tolocal]

> **toLocal**\<`P`>(`position`, `from?`, `point?`, `skipUpdate?`): `P`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/toLocalGlobalMixin.d.ts:100

Calculates the local position of the container relative to another point.
Converts coordinates from any coordinate space to this container's local coordinate space.

#### Type Parameters [#type-parameters-20]

##### P [#p-1]

`P` *extends* `PointData` = `Point`

#### Parameters [#parameters-78]

##### position [#position-2]

`PointData`

The world origin to calculate from

##### from? [#from]

`Container`\<`ContainerChild`>

The Container to calculate the global position from

##### point? [#point-3]

`P`

A Point object in which to store the value

##### skipUpdate? [#skipupdate-6]

`boolean`

Should we skip the update transform

#### Returns [#returns-126]

`P`

A point object representing the position in local space

#### Example [#example-123]

```ts
// Basic coordinate conversion
const worldPoint = { x: 100, y: 100 };
const localPos = container.toLocal(worldPoint);

// Convert from another container
const fromSprite = new Sprite(texture);
fromSprite.position.set(50, 50);
const pointInSprite = { x: 10, y: 10 };
const localPoint = container.toLocal(pointInSprite, fromSprite);

// With point reuse for performance
const reusePoint = new Point();
container.toLocal(worldPoint, undefined, reusePoint);

// Skip transform update for static objects
const fastLocal = container.toLocal(
    worldPoint,
    undefined,
    undefined,
    true
);
```

#### See [#see-49]

* [Container#toGlobal](#toglobal) For reverse conversion
* [Container#getGlobalPosition](#getglobalposition) For container position

#### Inherited from [#inherited-from-202]

`ImageSprite.toLocal`

***

### unload() [#unload]

> **unload**(): `void`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:110

Unloads the GPU data from the view.

#### Returns [#returns-127]

`void`

#### Inherited from [#inherited-from-203]

`ImageSprite.unload`

***

### updateLocalTransform() [#updatelocaltransform]

> **updateLocalTransform**(): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1225

Updates the local transform.

#### Returns [#returns-128]

`void`

#### Inherited from [#inherited-from-204]

`ImageSprite.updateLocalTransform`

***

### updateTransform() [#updatetransform]

> **updateTransform**(`opts`): `this`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:1195

Updates the transform properties of the container.
Allows partial updates of transform properties for optimized manipulation.

#### Parameters [#parameters-79]

##### opts [#opts]

`Partial`\<`UpdateTransformOptions`>

Transform options to update

#### Returns [#returns-129]

`this`

This container, for chaining

#### Example [#example-124]

```ts
// Basic transform update
container.updateTransform({
    x: 100,
    y: 200,
    rotation: Math.PI / 4
});

// Scale and rotate around center
sprite.updateTransform({
    pivotX: sprite.width / 2,
    pivotY: sprite.height / 2,
    scaleX: 2,
    scaleY: 2,
    rotation: Math.PI
});

// Update position only
button.updateTransform({
    x: button.x + 10, // Move right
    y: button.y      // Keep same y
});
```

#### See [#see-50]

* Container#setFromMatrix For matrix-based transforms
* Container#position For direct position access

#### Inherited from [#inherited-from-205]

`ImageSprite.updateTransform`

***

### from() [#from-1]

\> `static` **from**(`source`, `skipCache?`): `ImageSprite`\<`ImageSpriteMemory`>

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:850

#### Parameters [#parameters-80]

##### source [#source]

`Texture`\<`TextureSource`\<`any`>> | `TextureSourceLike`

##### skipCache? [#skipcache]

`boolean`

#### Returns [#returns-130]

`ImageSprite`\<`ImageSpriteMemory`>

#### Inherited from [#inherited-from-206]

`ImageSprite.from`

***

### ~~mixin()~~ [#mixin]

\> `static` **mixin**(`source`): `void`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:605

Mixes all enumerable properties and methods from a source object to Container.

#### Parameters [#parameters-81]

##### source [#source-1]

`Dict`\<`any`>

The source of properties and methods to mix in.

#### Returns [#returns-131]

`void`

#### Deprecated [#deprecated-3]

since 8.8.0

#### Inherited from [#inherited-from-207]

`ImageSprite.mixin`


# Function: showBackground() (/pixi-vn-ai/index/functions/showBackground)



\> **showBackground**(`alias`, `request`, `options?`): `Promise`\<[`AIImageSprite`](/pixi-vn-ai/index/classes/AIImageSprite)\<[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)>>

Defined in: [src/show.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/show.ts#L23)

Generate a background image and show it on the canvas, filling it edge-to-edge. This is the
combination of `ai.image.generateBackground` and Pixi'VN's `showImage`, using
[AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite) so the generated image itself is saved with the game and can be restored
on load without generating it again.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the background. You can use this alias to refer to it later
(e.g. to replace it with another generated background).

### request [#request]

`string`

Natural language description of the background to generate.

### options? [#options]

[`BackgroundImageGenerateOptions`](/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)

Options controlling which context gets included in the prompt.

## Returns [#returns]

`Promise`\<[`AIImageSprite`](/pixi-vn-ai/index/classes/AIImageSprite)\<[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)>>

The [AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite) added to the canvas.


# Function: showDialog() (/pixi-vn-ai/index/functions/showDialog)



\> **showDialog**(`request`, `character?`, `options?`): `Promise`\<`string`>

Defined in: [src/show.ts:66](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/show.ts#L66)

Generate a dialogue from a developer request and set it as the current Pixi'VN narration
dialogue. This is the combination of `ai.text.generateDialog` and Pixi'VN's
`narration.dialogue`.

## Parameters [#parameters]

### request [#request]

`string`

Natural language description of the dialogue to generate.

### character? [#character]

[`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem)

The character speaking, if any. Set as the dialogue's character, and also
used as [DialogGenerateOptions.speaker](/pixi-vn-ai/index/interfaces/DialogGenerateOptions#speaker) (so the model knows who it's writing for) when
`options.speaker` isn't already set.

### options? [#options]

[`DialogGenerateOptions`](/pixi-vn-ai/index/interfaces/DialogGenerateOptions)

Options controlling which context gets included in the prompt.

## Returns [#returns]

`Promise`\<`string`>

The generated dialogue text.


# Function: showElement() (/pixi-vn-ai/index/functions/showElement)



\> **showElement**(`alias`, `request`, `options?`): `Promise`\<[`AIImageSprite`](/pixi-vn-ai/index/classes/AIImageSprite)\<[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)>>

Defined in: [src/show.ts:46](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/show.ts#L46)

Generate a single visual element and show it on the canvas, positioned with
[ElementImageGenerateOptions.align](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions#align) (the only supported way to position it: there is no
raw x/y here, since the position is already the one the image itself was composed for). This is
the combination of `ai.image.generateElement` and Pixi'VN's `showImage`, using
[AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite) so the generated image itself is saved with the game and can be restored
on load without generating it again.

## Parameters [#parameters]

### alias [#alias]

`string`

The unique alias of the element. You can use this alias to refer to it later
(e.g. to replace it with another generated element).

### request [#request]

`string`

Natural language description of the element to generate.

### options? [#options]

[`ElementImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions)

Options controlling which context gets included in the prompt, and where the
element is positioned on the canvas (`align`).

## Returns [#returns]

`Promise`\<[`AIImageSprite`](/pixi-vn-ai/index/classes/AIImageSprite)\<[`AIImageSpriteMemory`](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)>>

The [AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite) added to the canvas.


# index (/pixi-vn-ai/index)



## Namespaces [#namespaces]

* [ai](/pixi-vn-ai/index/namespaces/ai)

## Classes [#classes]

* [AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite)

## Interfaces [#interfaces]

* [AIImageSpriteMemory](/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)
* [BackgroundImageGenerateOptions](/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)
* [DialogGenerateOptions](/pixi-vn-ai/index/interfaces/DialogGenerateOptions)
* [ElementImageGenerateOptions](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions)
* [GenerateOptions](/pixi-vn-ai/index/interfaces/GenerateOptions)
* [ImageGenerateOptions](/pixi-vn-ai/index/interfaces/ImageGenerateOptions)
* [PromptSection](/pixi-vn-ai/index/interfaces/PromptSection)
* [PromptTemplate](/pixi-vn-ai/index/interfaces/PromptTemplate)
* [Templates](/pixi-vn-ai/index/interfaces/Templates)

## Type Aliases [#type-aliases]

* [CharacterItem](/pixi-vn-ai/index/type-aliases/CharacterItem)

## Variables [#variables]

* [AI_IMAGE_SPRITE_ID](/pixi-vn-ai/index/variables/AI_IMAGE_SPRITE_ID)

## Functions [#functions]

* [showBackground](/pixi-vn-ai/index/functions/showBackground)
* [showDialog](/pixi-vn-ai/index/functions/showDialog)
* [showElement](/pixi-vn-ai/index/functions/showElement)


# Interface: AIImageSpriteMemory (/pixi-vn-ai/index/interfaces/AIImageSpriteMemory)



Defined in: [src/canvas/AIImageSprite.ts:16](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L16)

Memory of an [AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite): the same as ImageSpriteMemory, plus the generated
image itself.

## Extends [#extends]

* `ImageSpriteMemory`

## Properties [#properties]

### accessible? [#accessible]

\> `optional` **accessible?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a
shadow div with attributes set

#### Default [#default]

```ts
false
```

#### Example [#example]

```js
const container = new Container();
container.accessible = true;
```

#### Inherited from [#inherited-from]

`ImageSpriteMemory.accessible`

***

### accessibleChildren? [#accessiblechildren]

\> `optional` **accessibleChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to
be accessible. Defaults to true.

#### Default [#default-1]

```ts
true
```

#### Example [#example-1]

```js
const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false
```

#### Inherited from [#inherited-from-1]

`ImageSpriteMemory.accessibleChildren`

***

### accessibleHint? [#accessiblehint]

\> `optional` **accessibleHint?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

#### Default [#default-2]

```ts
null
```

#### Advanced [#advanced]

#### Example [#example-2]

```js
const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';
```

#### Inherited from [#inherited-from-2]

`ImageSpriteMemory.accessibleHint`

***

### accessiblePointerEvents? [#accessiblepointerevents]

\> `optional` **accessiblePointerEvents?**: `PointerEvents`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use
Defaults to auto.

#### Default [#default-3]

```ts
'auto'
```

#### Advanced [#advanced-1]

#### Example [#example-3]

```js
const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.
```

#### Inherited from [#inherited-from-3]

`ImageSpriteMemory.accessiblePointerEvents`

***

### accessibleText? [#accessibletext]

\> `optional` **accessibleText?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

#### Default [#default-4]

```ts
null
```

#### Example [#example-4]

```js
const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';
```

#### Inherited from [#inherited-from-4]

`ImageSpriteMemory.accessibleText`

***

### accessibleTitle? [#accessibletitle]

\> `optional` **accessibleTitle?**: `string` | `null`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div
If accessibleTitle AND accessibleHint has not been this will default to 'container \[tabIndex]'

#### Default [#default-5]

```ts
null
```

#### Example [#example-5]

```js
const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';
```

#### Inherited from [#inherited-from-5]

`ImageSpriteMemory.accessibleTitle`

***

### accessibleType? [#accessibletype]

\> `optional` **accessibleType?**: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently
depending on this type. Defaults to button.

#### Default [#default-6]

```ts
'button'
```

#### Advanced [#advanced-2]

#### Example [#example-6]

```js
const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.
```

#### Inherited from [#inherited-from-6]

`ImageSpriteMemory.accessibleType`

***

### align? [#align]

\> `optional` **align?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:232

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-7]

`ImageSpriteMemory.align`

***

### alpha? [#alpha]

\> `optional` **alpha?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity.
Value ranges from 0 (fully transparent) to 1 (fully opaque).

#### Example [#example-7]

```ts
new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque
```

#### Default [#default-7]

```ts
1
```

#### See [#see]

* Container#visible For toggling visibility
* Container#renderable For render control

#### Inherited from [#inherited-from-8]

`ImageSpriteMemory.alpha`

***

### anchor? [#anchor]

\> `optional` **anchor?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:73

The anchor point of the sprite (0-1 range).
Controls the origin point for rotation, scaling, and positioning.
Can be a number for uniform anchor or a PointData for separate x/y values.

#### Default [#default-8]

```ts
0
```

#### Example [#example-8]

```ts
// Centered anchor
anchor: 0.5
// Separate x/y anchor
anchor: { x: 0.5, y: 0.5 }
// Right-aligned anchor
anchor: { x: 1, y: 0 }
```

#### Inherited from [#inherited-from-9]

`ImageSpriteMemory.anchor`

***

### angle? [#angle]

\> `optional` **angle?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:247

The angle of the object in degrees.

\> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
\> rotation is in radians, angle is in degrees.

#### Example [#example-9]

```ts
new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-10]

`ImageSpriteMemory.angle`

***

### autoGarbageCollect? [#autogarbagecollect]

\> `optional` **autoGarbageCollect?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/view/ViewContainer.d.ts:29

If set to true, the resource will be garbage collected automatically when it is not used.

#### Inherited from [#inherited-from-11]

`ImageSpriteMemory.autoGarbageCollect`

***

### blendMode? [#blendmode]

\> `optional` **blendMode?**: `BLEND_MODES`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending.
\> \[!NOTE] More blend modes are available after importing the `pixi.js/advanced-blend-modes` sub-export.

#### Example [#example-10]

```ts
// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend
```

#### Default [#default-9]

```ts
'normal'
```

#### See [#see-1]

* Container#alpha For transparency
* Container#tint For color adjustments

#### Inherited from [#inherited-from-12]

`ImageSpriteMemory.blendMode`

***

### boundsArea? [#boundsarea]

\> `optional` **boundsArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:403

An optional bounds area for this container. Setting this rectangle will stop the renderer
from recursively measuring the bounds of each children and instead use this single boundArea.

\> \[!IMPORTANT] This is great for optimisation! If for example you have a
\> 1000 spinning particles and you know they all sit within a specific bounds,
\> then setting it will mean the renderer will not need to measure the
\> 1000 children to find the bounds. Instead it will just use the bounds you set.

#### Example [#example-11]

```ts
const container = new Container({
   boundsArea: new Rectangle(0, 0, 500, 500) // Set a fixed bounds area
});
```

#### Inherited from [#inherited-from-13]

`ImageSpriteMemory.boundsArea`

***

### cacheAsTexture? [#cacheastexture]

\> `optional` **cacheAsTexture?**: (`val`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts:5

#### Parameters [#parameters]

##### val [#val]

`boolean` | `CacheAsTextureOptions`

#### Returns [#returns]

`void`

#### Inherited from [#inherited-from-14]

`ImageSpriteMemory.cacheAsTexture`

***

### children? [#children]

\> `readonly` `optional` **children?**: `ContainerChild`\[]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:265

The array of children of this container. Each child must be a Container or extend from it.

The array is read-only, but its contents can be modified using Container methods.

#### Example [#example-12]

```ts
new Container({
   children: [
       new Container(), // First child
       new Container(), // Second child
   ],
});
```

#### See [#see-2]

* Container#addChild For adding children
* Container#removeChild For removing children

#### Inherited from [#inherited-from-15]

`ImageSpriteMemory.children`

***

### cullable? [#cullable]

\> `optional` **cullable?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view.
When true, the object will not be rendered if its bounds are outside the visible area.

#### Example [#example-13]

```ts
const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;
```

#### Remarks [#remarks]

* Does not affect transform updates
* Applies to this object only
* Children follow their own cullable setting

#### Default [#default-10]

```ts
false
```

#### Inherited from [#inherited-from-16]

`ImageSpriteMemory.cullable`

***

### cullableChildren? [#cullablechildren]

\> `optional` **cullableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled.
When false, skips recursive culling checks for better performance.

#### Example [#example-14]

```ts
const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);
```

#### Remarks [#remarks-1]

* Improves performance for static scenes
* Useful when children are always within container bounds
* Parent culling still applies

#### Default [#default-11]

```ts
true
```

#### Inherited from [#inherited-from-17]

`ImageSpriteMemory.cullableChildren`

***

### cullArea? [#cullarea]

\> `optional` **cullArea?**: `Rectangle`

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:49

Custom shape used for culling calculations instead of object bounds.
Defined in local space coordinates relative to the object.
\> \[!NOTE]
\> Setting this to a custom Rectangle allows you to define a specific area for culling,
\> which can improve performance by avoiding expensive bounds calculations.

#### Example [#example-15]

```ts
const container = new Container();

// Define custom culling boundary
container.cullArea = new Rectangle(0, 0, 800, 600);

// Reset to use object bounds
container.cullArea = null;
```

#### Remarks [#remarks-2]

* Improves performance by avoiding bounds calculations
* Useful for containers with many children
* Set to null to use object bounds

#### Default [#default-12]

```ts
null
```

#### Inherited from [#inherited-from-18]

`ImageSpriteMemory.cullArea`

***

### cursor? [#cursor]

\> `optional` **cursor?**: `string` & `object` | `Cursor`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object.
Accepts any valid CSS cursor value or custom cursor URL.

#### Example [#example-16]

```ts
// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset
```

#### Default [#default-13]

```ts
undefined
```

#### See [#see-3]

* EventSystem.cursorStyles For setting global cursor styles
* [https://developer.mozilla.org/en-US/docs/Web/CSS/cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) MDN Cursor Documentation

#### Inherited from [#inherited-from-19]

`ImageSpriteMemory.cursor`

***

### eventMode? [#eventmode]

\> `optional` **eventMode?**: `EventMode`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

#### Example [#example-17]

```ts
const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';
```

Available modes:

* `'none'`: Ignores all interaction events, even on its children. Best for pure visuals.
* `'passive'`: **(default)** Does not emit events and ignores hit testing on itself and non-interactive
  children. Interactive children will still emit events.
* `'auto'`: Does not emit events but is hit tested if parent is interactive. Same as `interactive = false` in v7.
* `'static'`: Emit events and is hit tested. Same as `interactive = true` in v7. Best for buttons/UI.
* `'dynamic'`: Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

* Use `'none'` for pure visual elements
* Use `'passive'` for containers with some interactive children
* Use `'static'` for standard UI elements
* Use `'dynamic'` only when needed for moving/animated elements

#### Since [#since]

7.2.0

#### Inherited from [#inherited-from-20]

`ImageSpriteMemory.eventMode`

***

### filters? [#filters]

\> `optional` **filters?**: `Filter` | readonly `Filter`\[]

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:37

Sets the filters for the displayObject.
Filters are visual effects that can be applied to any display object and its children.

\> \[!IMPORTANT] This is a WebGL/WebGPU only feature and will be ignored by the canvas renderer.

#### Example [#example-18]

```ts
new Container({
    filters: [new BlurFilter(2), new ColorMatrixFilter()],
});
```

#### See [#see-4]

Filter For filter base class

#### Inherited from [#inherited-from-21]

`ImageSpriteMemory.filters`

***

### generatedImage? [#generatedimage]

\> `optional` **generatedImage?**: `string`

Defined in: [src/canvas/AIImageSprite.ts:21](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L21)

The image generated by `ai.image.generateBackground`/`ai.image.generateElement` that this
sprite is showing, as a data URI.

***

### height? [#height]

\> `optional` **height?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

#### Example [#example-19]

```ts
new Container({ height: 100});
```

#### Default [#default-14]

```ts
0
```

#### Inherited from [#inherited-from-22]

`ImageSpriteMemory.height`

***

### hitArea? [#hitarea]

\> `optional` **hitArea?**: `IHitArea` | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:297

Defines a custom hit area for pointer interaction testing. When set, this shape will be used
for hit testing instead of the container's standard bounds.

#### Example [#example-20]

```ts
import { Rectangle, Circle, Sprite } from 'pixi.js';

// Rectangular hit area
const button = new Sprite(texture);
button.eventMode = 'static';
button.hitArea = new Rectangle(0, 0, 100, 50);

// Circular hit area
const icon = new Sprite(texture);
icon.eventMode = 'static';
icon.hitArea = new Circle(32, 32, 32);

// Custom hit area with polygon
const custom = new Sprite(texture);
custom.eventMode = 'static';
custom.hitArea = new Polygon([0,0, 100,0, 100,100, 0,100]);

// Custom hit testing logic
sprite.hitArea = {
    contains(x: number, y: number) {
        // Custom collision detection
        return x >= 0 && x <= width && y >= 0 && y <= height;
    }
};
```

#### Remarks [#remarks-3]

* Takes precedence over the container's bounds for hit testing
* Can improve performance by simplifying collision checks
* Useful for irregular shapes or precise click areas

#### Inherited from [#inherited-from-23]

`ImageSpriteMemory.hitArea`

***

### index? [#index]

\> `optional` **index?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:182

The index of the container in its parent, if it has one

#### Inherited from [#inherited-from-24]

`ImageSpriteMemory.index`

***

### interactive? [#interactive]

\> `optional` **interactive?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for `eventMode` set to `'static'` or `'passive'`.
Setting this to true will enable interaction events like `pointerdown`, `click`, etc.
Setting it to false will disable all interaction events on this object.

#### See [#see-5]

[Container.eventMode](/pixi-vn-ai/index/classes/AIImageSprite#eventmode)

#### Example [#example-21]

```ts
// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'
```

#### Inherited from [#inherited-from-25]

`ImageSpriteMemory.interactive`

***

### interactiveChildren? [#interactivechildren]

\> `optional` **interactiveChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:261

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children,
improving performance for containers with many non-interactive children.

#### Default [#default-15]

```ts
true
```

#### Example [#example-22]

```ts
// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;
```

#### Inherited from [#inherited-from-26]

`ImageSpriteMemory.interactiveChildren`

***

### isRenderGroup? [#isrendergroup]

\> `optional` **isRenderGroup?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:188

#### See [#see-6]

Container#isRenderGroup

#### Inherited from [#inherited-from-27]

`ImageSpriteMemory.isRenderGroup`

***

### label? [#label]

\> `optional` **label?**: `string`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

#### Default [#default-16]

```ts
null
```

#### Inherited from [#inherited-from-28]

`ImageSpriteMemory.label`

***

### loadIsStarted [#loadisstarted]

\> **loadIsStarted**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:812

#### Inherited from [#inherited-from-29]

`ImageSpriteMemory.loadIsStarted`

***

### mask? [#mask]

\> `optional` **mask?**: `Mask`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:22

The mask to apply, which can be a Container or null.

If null, it clears the existing mask.

#### Example [#example-23]

````ts
// Set a mask
sprite.setMask({
    mask: graphics,
    inverse: false,
});

#### Inherited from

`ImageSpriteMemory.mask`

***

### onclick?

> `optional` **onclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`\> \| `null`

Defined in: node\_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:317

Property-based event handler for the `click` event.
Fired when a pointer device (mouse, touch, etc.) completes a click action.

#### Example

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('click', (event) =&gt; {
   console.log('Sprite clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onclick = (event) =&gt; {
    console.log('Clicked at:', event.global.x, event.global.y);
};
````

#### Default [#default-17]

```ts
null
```

#### Inherited from [#inherited-from-30]

`ImageSpriteMemory.onclick`

***

### onEvents? [#onevents]

> `optional` **onEvents?**: `OnEventsHandlers`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:357

#### Inherited from [#inherited-from-31]

`ImageSpriteMemory.onEvents`

***

### onglobalmousemove? [#onglobalmousemove]

> `optional` **onglobalmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:430

Property-based event handler for the `globalmousemove` event.

Fired when the mouse moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-24]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalmousemove', (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
});
// Using property-based handler
sprite.onglobalmousemove = (event) =&gt; {
    // Move sprite to mouse position
    sprite.position.copyFrom(event.global);
};
```

#### Default [#default-18]

```ts
null
```

#### Remarks [#remarks-4]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-32]

`ImageSpriteMemory.onglobalmousemove`

***

### onglobalpointermove? [#onglobalpointermove]

> `optional` **onglobalpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:637

Property-based event handler for the `globalpointermove` event.

Fired when the pointer moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-25]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globalpointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobalpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-19]

```ts
null
```

#### Remarks [#remarks-5]

* Fires even when the mouse is outside the object's bounds
* Useful for drag operations or global mouse tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globaltouchmove`

#### Inherited from [#inherited-from-33]

`ImageSpriteMemory.onglobalpointermove`

***

### onglobaltouchmove? [#onglobaltouchmove]

> `optional` **onglobaltouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:947

Property-based event handler for the `globaltouchmove` event.

Fired when a touch interaction moves anywhere, regardless of whether the pointer is over this object.
The object must have `eventMode` set to 'static' or 'dynamic' to receive this event.

#### Example [#example-26]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('globaltouchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onglobaltouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-20]

```ts
null
```

#### Remarks [#remarks-6]

* Fires even when the touch is outside the object's bounds
* Useful for drag operations or global touch tracking
* Must have `eventMode` set appropriately to receive events
* Part of the global move events family along with `globalpointermove` and `globalmousemove`

#### Inherited from [#inherited-from-34]

`ImageSpriteMemory.onglobaltouchmove`

***

### onmousedown? [#onmousedown]

> `optional` **onmousedown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:339

Property-based event handler for the `mousedown` event.
Fired when a mouse button is pressed while the pointer is over the object.

#### Example [#example-27]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousedown', (event) =&gt; {
   sprite.alpha = 0.5; // Visual feedback
   console.log('Mouse button:', event.button);
});
// Using property-based handler
sprite.onmousedown = (event) =&gt; {
    sprite.alpha = 0.5; // Visual feedback
    console.log('Mouse button:', event.button);
};
```

#### Default [#default-21]

```ts
null
```

#### Inherited from [#inherited-from-35]

`ImageSpriteMemory.onmousedown`

***

### onmouseenter? [#onmouseenter]

> `optional` **onmouseenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:359

Property-based event handler for the `mouseenter` event.
Fired when the mouse pointer enters the bounds of the object. Does not bubble.

#### Example [#example-28]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseenter', (event) =&gt; {
    sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseenter = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-22]

```ts
null
```

#### Inherited from [#inherited-from-36]

`ImageSpriteMemory.onmouseenter`

***

### onmouseleave? [#onmouseleave]

> `optional` **onmouseleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:379

Property-based event handler for the `mouseleave` event.
Fired when the pointer leaves the bounds of the display object. Does not bubble.

#### Example [#example-29]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseleave', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-23]

```ts
null
```

#### Inherited from [#inherited-from-37]

`ImageSpriteMemory.onmouseleave`

***

### onmousemove? [#onmousemove]

> `optional` **onmousemove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:401

Property-based event handler for the `mousemove` event.
Fired when the pointer moves while over the display object.

#### Example [#example-30]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mousemove', (event) =&gt; {
   // Get coordinates relative to the sprite
  console.log('Local:', event.getLocalPosition(sprite));
});
// Using property-based handler
sprite.onmousemove = (event) =&gt; {
    // Get coordinates relative to the sprite
    console.log('Local:', event.getLocalPosition(sprite));
};
```

#### Default [#default-24]

```ts
null
```

#### Inherited from [#inherited-from-38]

`ImageSpriteMemory.onmousemove`

***

### onmouseout? [#onmouseout]

> `optional` **onmouseout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:450

Property-based event handler for the `mouseout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-31]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseout = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-25]

```ts
null
```

#### Inherited from [#inherited-from-39]

`ImageSpriteMemory.onmouseout`

***

### onmouseover? [#onmouseover]

> `optional` **onmouseover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:470

Property-based event handler for the `mouseover` event.
Fired when the pointer moves onto the bounds of the display object.

#### Example [#example-32]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseover', (event) =&gt; {
     sprite.scale.set(1.1);
});
// Using property-based handler
sprite.onmouseover = (event) =&gt; {
    sprite.scale.set(1.1);
};
```

#### Default [#default-26]

```ts
null
```

#### Inherited from [#inherited-from-40]

`ImageSpriteMemory.onmouseover`

***

### onmouseup? [#onmouseup]

> `optional` **onmouseup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:490

Property-based event handler for the `mouseup` event.
Fired when a mouse button is released over the display object.

#### Example [#example-33]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseup = (event) =&gt; {
     sprite.scale.set(1.0);
};
```

#### Default [#default-27]

```ts
null
```

#### Inherited from [#inherited-from-41]

`ImageSpriteMemory.onmouseup`

***

### onmouseupoutside? [#onmouseupoutside]

> `optional` **onmouseupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:511

Property-based event handler for the `mouseupoutside` event.
Fired when a mouse button is released outside the display object that initially
registered a mousedown.

#### Example [#example-34]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('mouseupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onmouseupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-28]

```ts
null
```

#### Inherited from [#inherited-from-42]

`ImageSpriteMemory.onmouseupoutside`

***

### onpointercancel? [#onpointercancel]

> `optional` **onpointercancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:531

Property-based event handler for the `pointercancel` event.
Fired when a pointer device interaction is canceled or lost.

#### Example [#example-35]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointercancel', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointercancel = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-29]

```ts
null
```

#### Inherited from [#inherited-from-43]

`ImageSpriteMemory.onpointercancel`

***

### onpointerdown? [#onpointerdown]

> `optional` **onpointerdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:551

Property-based event handler for the `pointerdown` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is pressed.

#### Example [#example-36]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerdown', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointerdown = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-30]

```ts
null
```

#### Inherited from [#inherited-from-44]

`ImageSpriteMemory.onpointerdown`

***

### onpointerenter? [#onpointerenter]

> `optional` **onpointerenter?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:571

Property-based event handler for the `pointerenter` event.
Fired when a pointer device enters the bounds of the display object. Does not bubble.

#### Example [#example-37]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerenter', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerenter = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-31]

```ts
null
```

#### Inherited from [#inherited-from-45]

`ImageSpriteMemory.onpointerenter`

***

### onpointerleave? [#onpointerleave]

> `optional` **onpointerleave?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:590

Property-based event handler for the `pointerleave` event.
Fired when a pointer device leaves the bounds of the display object. Does not bubble.

#### Example [#example-38]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';
// Using emitter handler
sprite.on('pointerleave', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerleave = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-32]

```ts
null
```

#### Inherited from [#inherited-from-46]

`ImageSpriteMemory.onpointerleave`

***

### onpointermove? [#onpointermove]

> `optional` **onpointermove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:610

Property-based event handler for the `pointermove` event.
Fired when a pointer device moves while over the display object.

#### Example [#example-39]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointermove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointermove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-33]

```ts
null
```

#### Inherited from [#inherited-from-47]

`ImageSpriteMemory.onpointermove`

***

### onpointerout? [#onpointerout]

> `optional` **onpointerout?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:657

Property-based event handler for the `pointerout` event.
Fired when the pointer moves out of the bounds of the display object.

#### Example [#example-40]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerout', (event) =&gt; {
   sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerout = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-34]

```ts
null
```

#### Inherited from [#inherited-from-48]

`ImageSpriteMemory.onpointerout`

***

### onpointerover? [#onpointerover]

> `optional` **onpointerover?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:677

Property-based event handler for the `pointerover` event.
Fired when the pointer moves over the bounds of the display object.

#### Example [#example-41]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerover', (event) =&gt; {
    sprite.scale.set(1.2);
});
// Using property-based handler
sprite.onpointerover = (event) =&gt; {
    sprite.scale.set(1.2);
};
```

#### Default [#default-35]

```ts
null
```

#### Inherited from [#inherited-from-49]

`ImageSpriteMemory.onpointerover`

***

### onpointertap? [#onpointertap]

> `optional` **onpointertap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:697

Property-based event handler for the `pointertap` event.
Fired when a pointer device completes a tap action (e.g., touch or mouse click).

#### Example [#example-42]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointertap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onpointertap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-36]

```ts
null
```

#### Inherited from [#inherited-from-50]

`ImageSpriteMemory.onpointertap`

***

### onpointerup? [#onpointerup]

> `optional` **onpointerup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:717

Property-based event handler for the `pointerup` event.
Fired when a pointer device button (mouse, touch, pen, etc.) is released.

#### Example [#example-43]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-37]

```ts
null
```

#### Inherited from [#inherited-from-51]

`ImageSpriteMemory.onpointerup`

***

### onpointerupoutside? [#onpointerupoutside]

> `optional` **onpointerupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:738

Property-based event handler for the `pointerupoutside` event.
Fired when a pointer device button is released outside the bounds of the display object
that initially registered a pointerdown.

#### Example [#example-44]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('pointerupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onpointerupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-38]

```ts
null
```

#### Inherited from [#inherited-from-52]

`ImageSpriteMemory.onpointerupoutside`

***

### onRender? [#onrender]

> `optional` **onRender?**: ((`renderer`) => `void`) | `null`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/onRenderMixin.d.ts:25

This callback is used when the container is rendered. It runs every frame during the render process,
making it ideal for per-frame updates and animations.

> \[!NOTE] In v7 many users used `updateTransform` for this, however the way v8 renders objects is different
> and "updateTransform" is no longer called every frame

#### Example [#example-45]

```ts
// Basic rotation animation
const container = new Container();
container.onRender = () =&gt; {
    container.rotation += 0.01;
};

// Cleanup when done
container.onRender = null; // Removes callback
```

#### Param [#param]

**renderer**

The renderer instance

#### See [#see-7]

Renderer For renderer capabilities

#### Inherited from [#inherited-from-53]

`ImageSpriteMemory.onRender`

***

### onrightclick? [#onrightclick]

> `optional` **onrightclick?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:758

Property-based event handler for the `rightclick` event.
Fired when a right-click (context menu) action is performed on the object.

#### Example [#example-46]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightclick', (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.onrightclick = (event) =&gt; {
    console.log('Right-clicked at:', event.global.x, event.global.y);
};
```

#### Default [#default-39]

```ts
null
```

#### Inherited from [#inherited-from-54]

`ImageSpriteMemory.onrightclick`

***

### onrightdown? [#onrightdown]

> `optional` **onrightdown?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:778

Property-based event handler for the `rightdown` event.
Fired when a right mouse button is pressed down over the display object.

#### Example [#example-47]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightdown', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.onrightdown = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-40]

```ts
null
```

#### Inherited from [#inherited-from-55]

`ImageSpriteMemory.onrightdown`

***

### onrightup? [#onrightup]

> `optional` **onrightup?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:798

Property-based event handler for the `rightup` event.
Fired when a right mouse button is released over the display object.

#### Example [#example-48]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightup', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightup = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-41]

```ts
null
```

#### Inherited from [#inherited-from-56]

`ImageSpriteMemory.onrightup`

***

### onrightupoutside? [#onrightupoutside]

> `optional` **onrightupoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:819

Property-based event handler for the `rightupoutside` event.
Fired when a right mouse button is released outside the bounds of the display object
that initially registered a rightdown.

#### Example [#example-49]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('rightupoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.onrightupoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-42]

```ts
null
```

#### Inherited from [#inherited-from-57]

`ImageSpriteMemory.onrightupoutside`

***

### ontap? [#ontap]

> `optional` **ontap?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:839

Property-based event handler for the `tap` event.
Fired when a tap action (touch) is completed on the object.

#### Example [#example-50]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('tap', (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontap = (event) =&gt; {
    console.log('Sprite tapped at:', event.global.x, event.global.y);
};
```

#### Default [#default-43]

```ts
null
```

#### Inherited from [#inherited-from-58]

`ImageSpriteMemory.ontap`

***

### ontouchcancel? [#ontouchcancel]

> `optional` **ontouchcancel?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:859

Property-based event handler for the `touchcancel` event.
Fired when a touch interaction is canceled, such as when the touch is interrupted.

#### Example [#example-51]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchcancel', (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchcancel = (event) =&gt; {
    console.log('Touch canceled at:', event.global.x, event.global.y);
};
```

#### Default [#default-44]

```ts
null
```

#### Inherited from [#inherited-from-59]

`ImageSpriteMemory.ontouchcancel`

***

### ontouchend? [#ontouchend]

> `optional` **ontouchend?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:879

Property-based event handler for the `touchend` event.
Fired when a touch interaction ends, such as when the finger is lifted from the screen.

#### Example [#example-52]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchend', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchend = (event) =&gt; {
   sprite.scale.set(1.0);
};
```

#### Default [#default-45]

```ts
null
```

#### Inherited from [#inherited-from-60]

`ImageSpriteMemory.ontouchend`

***

### ontouchendoutside? [#ontouchendoutside]

> `optional` **ontouchendoutside?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:900

Property-based event handler for the `touchendoutside` event.
Fired when a touch interaction ends outside the bounds of the display object
that initially registered a touchstart.

#### Example [#example-53]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchendoutside', (event) =&gt; {
    sprite.scale.set(1.0);
});
// Using property-based handler
sprite.ontouchendoutside = (event) =&gt; {
    sprite.scale.set(1.0);
};
```

#### Default [#default-46]

```ts
null
```

#### Inherited from [#inherited-from-61]

`ImageSpriteMemory.ontouchendoutside`

***

### ontouchmove? [#ontouchmove]

> `optional` **ontouchmove?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:920

Property-based event handler for the `touchmove` event.
Fired when a touch interaction moves while over the display object.

#### Example [#example-54]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchmove', (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
});
// Using property-based handler
sprite.ontouchmove = (event) =&gt; {
    sprite.position.set(event.global.x, event.global.y);
};
```

#### Default [#default-47]

```ts
null
```

#### Inherited from [#inherited-from-62]

`ImageSpriteMemory.ontouchmove`

***

### ontouchstart? [#ontouchstart]

> `optional` **ontouchstart?**: `FederatedEventHandler`\<`FederatedPointerEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:967

Property-based event handler for the `touchstart` event.
Fired when a touch interaction starts, such as when a finger touches the screen.

#### Example [#example-55]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('touchstart', (event) =&gt; {
    sprite.scale.set(0.9);
});
// Using property-based handler
sprite.ontouchstart = (event) =&gt; {
    sprite.scale.set(0.9);
};
```

#### Default [#default-48]

```ts
null
```

#### Inherited from [#inherited-from-63]

`ImageSpriteMemory.ontouchstart`

***

### onwheel? [#onwheel]

> `optional` **onwheel?**: `FederatedEventHandler`\<`FederatedWheelEvent`> | `null`

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:989

Property-based event handler for the `wheel` event.
Fired when the mouse wheel is scrolled while over the display object.

#### Example [#example-56]

```ts
const sprite = new Sprite(texture);
sprite.eventMode = 'static';

// Using emitter handler
sprite.on('wheel', (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
});
// Using property-based handler
sprite.onwheel = (event) =&gt; {
    sprite.scale.x += event.deltaY * 0.01; // Zoom in/out
    sprite.scale.y += event.deltaY * 0.01; // Zoom in/out
};
```

#### Default [#default-49]

```ts
null
```

#### Inherited from [#inherited-from-64]

`ImageSpriteMemory.onwheel`

***

### origin? [#origin]

> `optional` **origin?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:334

The origin point around which the container rotates and scales.
Unlike pivot, changing origin will not move the container's position.

#### Example [#example-57]

```ts
new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)
```

#### Inherited from [#inherited-from-65]

`ImageSpriteMemory.origin`

***

### parent? [#parent]

> `readonly` `optional` **parent?**: `Container`\<`ContainerChild`>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:273

The display object container that contains this display object.
This represents the parent-child relationship in the display tree.

#### See [#see-8]

* Container#addChild For adding to a parent
* Container#removeChild For removing from parent

#### Inherited from [#inherited-from-66]

`ImageSpriteMemory.parent`

***

### parentLabel? [#parentlabel]

> `optional` **parentLabel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:186

The label of the parent container, if it has one

#### Inherited from [#inherited-from-67]

`ImageSpriteMemory.parentLabel`

***

### percentagePosition? [#percentageposition]

> `optional` **percentagePosition?**: `number` | `Partial`\<`PointData`>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:262

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-68]

`ImageSpriteMemory.percentagePosition`

***

### percentageX? [#percentagex]

> `optional` **percentageX?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:272

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-69]

`ImageSpriteMemory.percentageX`

***

### percentageY? [#percentagey]

> `optional` **percentageY?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:282

is a way to set the position of the element in the canvas calculated in percentage.
For example, if you set the PixiContainer.pivot to 0.5, and:

* if you set percentagePosition to 0.5, the element will be in the center of the canvas.
* If you set percentagePosition to 0, the center of the element will be in the left end and top end of the canvas.
* If you set percentagePosition to 1, the center of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does affect the percentagePosition.

#### Inherited from [#inherited-from-70]

`ImageSpriteMemory.percentageY`

***

### pivot? [#pivot]

> `optional` **pivot?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:323

The center of rotation, scaling, and skewing for this display object in its local space.
The `position` is the projection of `pivot` in the parent's local space.

By default, the pivot is the origin (0, 0).

#### Example [#example-58]

```ts
new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)
```

#### Inherited from [#inherited-from-71]

`ImageSpriteMemory.pivot`

***

### pixivnId [#pixivnid]

> **pixivnId**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:178

#### Inherited from [#inherited-from-72]

`ImageSpriteMemory.pixivnId`

***

### position? [#position]

> `optional` **position?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:343

The coordinate of the object relative to the local coordinates of the parent.

#### Example [#example-59]

```ts
new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)
```

#### Inherited from [#inherited-from-73]

`ImageSpriteMemory.position`

***

### renderable? [#renderable]

> `optional` **renderable?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:286

Controls whether this object can be rendered. If false the object will not be drawn,
but the transform will still be updated. This is different from visible, which skips
transform updates.

#### Example [#example-60]

```ts
new Container({ renderable: false }); // Will not be drawn, but transforms will update
```

#### Default [#default-50]

```ts
true
```

#### See [#see-9]

* Container#visible For skipping transform updates
* Container#alpha For transparency

#### Inherited from [#inherited-from-74]

`ImageSpriteMemory.renderable`

***

### rotation? [#rotation]

> `optional` **rotation?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:298

The rotation of the object in radians.

> \[!NOTE] 'rotation' and 'angle' have the same effect on a display object;
> rotation is in radians, angle is in degrees.

#### Example [#example-61]

```ts
new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees
```

#### Inherited from [#inherited-from-75]

`ImageSpriteMemory.rotation`

***

### roundPixels? [#roundpixels]

> `optional` **roundPixels?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:86

Whether or not to round the x/y position to whole pixels.
Useful for crisp pixel art style rendering.

#### Default [#default-51]

```ts
false
```

#### Example [#example-62]

```ts
const sprite = new Sprite({
    texture: Texture.from('sprite.png'),
    roundPixels: true // Ensures crisp rendering
});
```

#### Inherited from [#inherited-from-76]

`ImageSpriteMemory.roundPixels`

***

### scale? [#scale]

> `optional` **scale?**: `number` | `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:310

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

#### Example [#example-63]

```ts
new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x
```

#### Inherited from [#inherited-from-77]

`ImageSpriteMemory.scale`

***

### setMask? [#setmask]

> `optional` **setMask?**: (`options`) => `void`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

#### Parameters [#parameters-1]

##### options [#options]

`Partial`\<`MaskOptionsAndMask`>

#### Returns [#returns-1]

`void`

#### Inherited from [#inherited-from-78]

`ImageSpriteMemory.setMask`

***

### skew? [#skew]

> `optional` **skew?**: `PointData`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:354

The skew factor for the object in radians. Skewing is a transformation that distorts
the object by rotating it differently at each point, creating a non-uniform shape.

#### Example [#example-64]

```ts
new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y
```

#### Default [#default-52]

```ts
{ x: 0, y: 0 }
```

#### Inherited from [#inherited-from-79]

`ImageSpriteMemory.skew`

***

### sortableChildren? [#sortablechildren]

> `optional` **sortableChildren?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by `zIndex` value
when the next render is called, or manually if `sortChildren()` is called.

This actually changes the order of elements in the array of children,
so it will affect the rendering order.

> \[!NOTE] Also be aware of that this may not work nicely with the `addChildAt()` function,
> as the `zIndex` sorting may cause the child to automatically sorted to another position.

#### Example [#example-65]

```ts
container.sortableChildren = true;
```

#### Default [#default-53]

```ts
false
```

#### Inherited from [#inherited-from-80]

`ImageSpriteMemory.sortableChildren`

***

### sortDirty? [#sortdirty]

> `optional` **sortDirty?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

**`Internal`**

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

#### Default [#default-54]

```ts
false
@internal
```

#### Inherited from [#inherited-from-81]

`ImageSpriteMemory.sortDirty`

***

### tabIndex? [#tabindex]

> `optional` **tabIndex?**: `number`

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the
elements when using the tab key to navigate.

#### Default [#default-55]

```ts
0
```

#### Example [#example-66]

```js
const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;
```

#### Inherited from [#inherited-from-82]

`ImageSpriteMemory.tabIndex`

***

### texture? [#texture]

> `optional` **texture?**: `Texture`\<`TextureSource`\<`any`>>

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:57

The texture to use for the sprite. If not provided, uses Texture.EMPTY

#### Default [#default-56]

```ts
Texture.EMPTY
```

#### Example [#example-67]

```ts
// Create a sprite with a texture
const sprite = new Sprite({
    texture: Texture.from('path/to/image.png')
});
// Update the texture later
sprite.texture = Texture.from('path/to/another-image.png');
```

#### Inherited from [#inherited-from-83]

`ImageSpriteMemory.texture`

***

### textureData? [#texturedata]

> `optional` **textureData?**: `AssetMemory`

Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:722

#### Inherited from [#inherited-from-84]

`ImageSpriteMemory.textureData`

***

### tint? [#tint]

> `optional` **tint?**: `ColorSource`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:222

The tint applied to the sprite.

This can be any valid ColorSource.

#### Example [#example-68]

```ts
new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint
```

#### Default [#default-57]

```ts
0xFFFFFF
```

#### See [#see-10]

* Container#alpha For transparency
* Container#visible For visibility control

#### Inherited from [#inherited-from-85]

`ImageSpriteMemory.tint`

***

### visible? [#visible]

> `optional` **visible?**: `boolean`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:367

The visibility of the object. If false the object will not be drawn,
and the transform will not be updated.

#### Example [#example-69]

```ts
new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update
```

#### Default [#default-58]

```ts
true
```

#### See [#see-11]

* Container#renderable For render-only control
* Container#alpha For transparency

#### Inherited from [#inherited-from-86]

`ImageSpriteMemory.visible`

***

### width? [#width]

> `optional` **width?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

#### Example [#example-70]

```ts
new Container({ width: 100});
```

#### Default [#default-59]

```ts
0
```

#### Inherited from [#inherited-from-87]

`ImageSpriteMemory.width`

***

### x? [#x]

> `optional` **x?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:377

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

#### Example [#example-71]

```ts
new Container({ x: 100 }); // Set x position to 100
```

#### Inherited from [#inherited-from-88]

`ImageSpriteMemory.x`

***

### xAlign? [#xalign]

> `optional` **xAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:242

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-89]

`ImageSpriteMemory.xAlign`

***

### y? [#y]

> `optional` **y?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:387

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

#### Example [#example-72]

```ts
new Container({ y: 200 }); // Set y position to 200
```

#### Inherited from [#inherited-from-90]

`ImageSpriteMemory.y`

***

### yAlign? [#yalign]

> `optional` **yAlign?**: `number`

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w\.d.ts:252

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas.
For example:

* if you set align to 0.5, the element will be in the center of the canvas.
* if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
* if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

**Important:** The PixiContainer.pivot field does not affect the alignment.

#### Inherited from [#inherited-from-91]

`ImageSpriteMemory.yAlign`

***

### zIndex? [#zindex]

> `optional` **zIndex?**: `number`

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

#### Example [#example-73]

```ts
// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;
```

#### See [#see-12]

* [Container#sortableChildren](/pixi-vn-ai/index/classes/AIImageSprite#sortablechildren) For enabling sorting
* Container#sortChildren For manual sorting

#### Default [#default-60]

```ts
0
```

#### Inherited from [#inherited-from-92]

`ImageSpriteMemory.zIndex`


# Interface: BackgroundImageGenerateOptions (/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)



Defined in: [src/types/BackgroundImageGenerateOptions.ts:9](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/BackgroundImageGenerateOptions.ts#L9)

Options accepted by [ai.image.generateBackground](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateBackground).

The generated image is meant to fill the whole game canvas: its size is read directly from
Pixi'VN and included in the prompt, so developers never have to pass it manually.

## Extends [#extends]

* [`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#history)

***

### referenceImage? [#referenceimage]

\> `optional` **referenceImage?**: `string`

Defined in: [src/types/ImageGenerateOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ImageGenerateOptions.ts#L11)

Optional reference image, forwarded to providers that support image-to-image generation.

#### Inherited from [#inherited-from-2]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`referenceImage`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#referenceimage)

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-3]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#scene)

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

Desired style (tone of voice, art style, etc).

#### Inherited from [#inherited-from-4]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#style)


# Interface: DialogGenerateOptions (/pixi-vn-ai/index/interfaces/DialogGenerateOptions)



Defined in: [src/types/DialogGenerateOptions.ts:7](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L7)

Options accepted by [ai.text.generateDialog](/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog).

## Extends [#extends]

* [`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/GenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/GenerateOptions#history)

***

### language? [#language]

\> `optional` **language?**: `string`

Defined in: [src/types/DialogGenerateOptions.ts:24](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L24)

Output language.

***

### listeners? [#listeners]

\> `optional` **listeners?**: [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem) | [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem)\[]

Defined in: [src/types/DialogGenerateOptions.ts:20](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L20)

Character(s) receiving the dialogue.

Can be any serializable object (or array of objects).

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-2]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/GenerateOptions#scene)

***

### speaker? [#speaker]

\> `optional` **speaker?**: [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem) | [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem)\[]

Defined in: [src/types/DialogGenerateOptions.ts:14](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L14)

Character(s) speaking.

Can be any serializable object (or array of objects). Pixi'VN AI does not define a
`Character` model: developers are free to pass whatever shape fits their game.

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

Desired style (tone of voice, art style, etc).

#### Inherited from [#inherited-from-3]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/GenerateOptions#style)


# Interface: ElementImageGenerateOptions (/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions)



Defined in: [src/types/ElementImageGenerateOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ElementImageGenerateOptions.ts#L11)

Options accepted by [ai.image.generateElement](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateElement).

Generates a single visual element (e.g. a character) meant to be layered on top of other
visuals: the area behind the subject is transparent, and [align](#align) describes where it will
be positioned on screen so the model can compose it accordingly.

## Extends [#extends]

* [`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions)

## Properties [#properties]

### align? [#align]

\> `optional` **align?**: `object`

Defined in: [src/types/ElementImageGenerateOptions.ts:31](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ElementImageGenerateOptions.ts#L31)

Position of the element within the canvas (Pixi'VN's `align`, see
[https://pixi-vn.com/start/canvas-position](https://pixi-vn.com/start/canvas-position)). Each axis is a 0-1 fraction of the canvas'
width/height that is also used as the element's own anchor on that axis, so the value
describes both where on the canvas the point sits and which point of the element is placed
there: `0` = the element's left/top edge is flush against the canvas' left/top edge, `1` =
the element's right/bottom edge is flush against the canvas' right/bottom edge, `0.5` =
centered on that axis.

#### x [#x]

\> **x**: `number`

Horizontal position, as a 0-1 fraction of the canvas' width.

#### y [#y]

\> **y**: `number`

Vertical position, as a 0-1 fraction of the canvas' height.

***

### backgroundImage? [#backgroundimage]

\> `optional` **backgroundImage?**: `string` | `true`

Defined in: [src/types/ElementImageGenerateOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ElementImageGenerateOptions.ts#L21)

The background image this element will be placed over, so the model can compose the
subject coherently with what's behind it (lighting, perspective, scale, ...).

Pass `true` to use whatever is currently rendered on the game canvas instead of a specific
asset.

Forwarded to the provider as the reference image when [referenceImage](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#referenceimage) isn't set.

***

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#history)

***

### referenceImage? [#referenceimage]

\> `optional` **referenceImage?**: `string`

Defined in: [src/types/ImageGenerateOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ImageGenerateOptions.ts#L11)

Optional reference image, forwarded to providers that support image-to-image generation.

#### Inherited from [#inherited-from-2]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`referenceImage`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#referenceimage)

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-3]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#scene)

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

Desired style (tone of voice, art style, etc).

#### Inherited from [#inherited-from-4]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#style)


# Interface: GenerateOptions (/pixi-vn-ai/index/interfaces/GenerateOptions)



Defined in: [src/types/GenerateOptions.ts:8](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L8)

Options shared by [ai.text.generateDialog](/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog), [ai.image.generateBackground](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateBackground) and
[ai.image.generateElement](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateElement).

These options describe *what* should be included in the generated prompt.
The actual prompt text is always assembled internally by the PromptBuilder.

## Extended by [#extended-by]

* [`DialogGenerateOptions`](/pixi-vn-ai/index/interfaces/DialogGenerateOptions)
* [`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

#### Default [#default]

```ts
true
```

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

Desired style (tone of voice, art style, etc).


# Interface: ImageGenerateOptions (/pixi-vn-ai/index/interfaces/ImageGenerateOptions)



Defined in: [src/types/ImageGenerateOptions.ts:7](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ImageGenerateOptions.ts#L7)

Options shared by [ai.image.generateBackground](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateBackground) and [ai.image.generateElement](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateElement).

## Extends [#extends]

* [`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions)

## Extended by [#extended-by]

* [`BackgroundImageGenerateOptions`](/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)
* [`ElementImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/GenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/GenerateOptions#history)

***

### referenceImage? [#referenceimage]

\> `optional` **referenceImage?**: `string`

Defined in: [src/types/ImageGenerateOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ImageGenerateOptions.ts#L11)

Optional reference image, forwarded to providers that support image-to-image generation.

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-2]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/GenerateOptions#scene)

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

Desired style (tone of voice, art style, etc).

#### Inherited from [#inherited-from-3]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/GenerateOptions#style)


# Interface: PromptSection (/pixi-vn-ai/index/interfaces/PromptSection)



Defined in: [src/types/PromptSection.ts:8](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptSection.ts#L8)

A single, independent block of a generated prompt.

The PromptBuilder assembles a prompt out of an ordered list of sections instead of
concatenating raw strings, so every piece of context (history, scene, speaker, ...) stays
isolated and easy to reason about.

## Properties [#properties]

### content [#content]

\> **content**: `string`

Defined in: [src/types/PromptSection.ts:22](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptSection.ts#L22)

Body of the section. Plain text or a serialized JSON string.

***

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/types/PromptSection.ts:18](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptSection.ts#L18)

Explains what [content](#content) is and how to interpret it, for content that isn't
self-descriptive (e.g. a serialized JSON object or array). Omit when the title and content
are already clear on their own (e.g. plain developer-provided text).

***

### title [#title]

\> **title**: `string`

Defined in: [src/types/PromptSection.ts:12](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptSection.ts#L12)

Heading of the section (e.g. "Scene", "Narrative History").


# Interface: PromptTemplate (/pixi-vn-ai/index/interfaces/PromptTemplate)



Defined in: [src/types/PromptTemplate.ts:7](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptTemplate.ts#L7)

A prompt template supplies the static instructions injected as the first section of a
generated prompt (e.g. output format rules). Everything else (developer request, history,
scene, ...) is assembled by the PromptBuilder, so templates stay small and easy to
override via [ai.templates](/pixi-vn-ai/index/namespaces/ai/namespaces/templates).

## Properties [#properties]

### instructions [#instructions]

\> **instructions**: `string`

Defined in: [src/types/PromptTemplate.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/PromptTemplate.ts#L11)

Instructions given to the model, e.g. output format and behavior rules.


# Interface: Templates (/pixi-vn-ai/index/interfaces/Templates)



Defined in: [src/types/Templates.ts:8](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/Templates.ts#L8)

The set of templates used to build prompts.

Assign to [ai.templates](/pixi-vn-ai/index/namespaces/ai/namespaces/templates) to override the built-in templates.

## Properties [#properties]

### dialog [#dialog]

\> **dialog**: [`PromptTemplate`](/pixi-vn-ai/index/interfaces/PromptTemplate)

Defined in: [src/types/Templates.ts:12](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/Templates.ts#L12)

Template used by [ai.text.generateDialog](/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog).

***

### image [#image]

\> **image**: [`PromptTemplate`](/pixi-vn-ai/index/interfaces/PromptTemplate)

Defined in: [src/types/Templates.ts:16](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/Templates.ts#L16)

Template used by ai.image.generate.


# Function: init() (/pixi-vn-ai/index/namespaces/ai/functions/init)



\> **init**(`options?`): `Promise`\<`void`>

Defined in: [src/ai.ts:35](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L35)

Initialize Pixi'VN AI. Call this once, typically at application startup, before using
`ai.text.generateDialog`, `ai.image.generateBackground` or `ai.image.generateElement`.

When neither option is given, a small local [WebLLM](https://github.com/mlc-ai/web-llm)
model is downloaded and used for dialogue generation (no image support).

## Parameters [#parameters]

### options? [#options]

The [AI SDK](https://ai-sdk.dev) models to use.

#### imageProvider? [#imageprovider]

`ImageModel`

Image model used for `ai.image.generateBackground` and `ai.image.generateElement`.

#### textProvider? [#textprovider]

`LanguageModel`

Language model used for `ai.text.generateDialog`, and as a fallback for image
generation on multimodal models (e.g. Gemini image generation).

## Returns [#returns]

`Promise`\<`void`>


# ai (/pixi-vn-ai/index/namespaces/ai)



The small, provider-independent public API of Pixi'VN AI.

Prompt engineering is entirely hidden: `ai.text.generateDialog`, `ai.image.generateBackground`
and `ai.image.generateElement` build the final prompt internally from the developer request,
the configured templates, and the [GenerateOptions](/pixi-vn-ai/index/interfaces/GenerateOptions) passed in (narrative history, scene,
...).

## Namespaces [#namespaces]

* [image](/pixi-vn-ai/index/namespaces/ai/namespaces/image)
* [templates](/pixi-vn-ai/index/namespaces/ai/namespaces/templates)
* [text](/pixi-vn-ai/index/namespaces/ai/namespaces/text)

## Functions [#functions]

* [init](/pixi-vn-ai/index/namespaces/ai/functions/init)


# Function: generateBackground() (/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateBackground)



\> **generateBackground**(`request`, `options?`): `Promise`\<`string`>

Defined in: [src/ai.ts:95](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L95)

Generate a background image from a developer request, completely hiding prompt
engineering.

The image is meant to fill the whole game canvas: its size is read directly from
Pixi'VN and included in the prompt, so it never has to be passed manually.

## Parameters [#parameters]

### request [#request]

`string`

Natural language description of the background to generate.

### options? [#options]

[`BackgroundImageGenerateOptions`](/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)

Options controlling which context gets included in the prompt.

## Returns [#returns]

`Promise`\<`string`>

The generated image, as a data URI, ready to use directly as a Pixi'VN image
source.


# Function: generateElement() (/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateElement)



\> **generateElement**(`request`, `options?`): `Promise`\<`string`>

Defined in: [src/ai.ts:124](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L124)

Generate a single visual element (e.g. a character) from a developer request,
completely hiding prompt engineering.

The image is meant to be layered on top of other visuals: the area behind the subject
is transparent, and [ElementImageGenerateOptions.align](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions#align) describes where it will
be positioned so the model can compose it accordingly.

## Parameters [#parameters]

### request [#request]

`string`

Natural language description of the element to generate.

### options? [#options]

[`ElementImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ElementImageGenerateOptions)

Options controlling which context gets included in the prompt.

## Returns [#returns]

`Promise`\<`string`>

The generated image, as a data URI, ready to use directly as a Pixi'VN image
source.


# image (/pixi-vn-ai/index/namespaces/ai/namespaces/image)



## Functions [#functions]

* [generateBackground](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateBackground)
* [generateElement](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/generateElement)


# templates (/pixi-vn-ai/index/namespaces/ai/namespaces/templates)



The templates used to build the prompts sent by `ai.text.generateDialog`,
`ai.image.generateBackground` and `ai.image.generateElement`.

Assign to `templates.dialog` / `templates.image.background` / `templates.image.element` to
override the built-in template.

## Namespaces [#namespaces]

* [image](/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image)

## Variables [#variables]

* [dialog](/pixi-vn-ai/index/namespaces/ai/namespaces/templates/variables/dialog)


# image (/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image)



## Variables [#variables]

* [background](/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image/variables/background)
* [element](/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image/variables/element)


# Variable: background (/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image/variables/background)



\> **background**: [`PromptTemplate`](/pixi-vn-ai/index/interfaces/PromptTemplate) = `DEFAULT_BACKGROUND_IMAGE_TEMPLATE`

Defined in: [src/ai.ts:62](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L62)


# Variable: element (/pixi-vn-ai/index/namespaces/ai/namespaces/templates/namespaces/image/variables/element)



\> **element**: [`PromptTemplate`](/pixi-vn-ai/index/interfaces/PromptTemplate) = `DEFAULT_ELEMENT_IMAGE_TEMPLATE`

Defined in: [src/ai.ts:64](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L64)


# Variable: dialog (/pixi-vn-ai/index/namespaces/ai/namespaces/templates/variables/dialog)



\> **dialog**: [`PromptTemplate`](/pixi-vn-ai/index/interfaces/PromptTemplate) = `DEFAULT_DIALOG_TEMPLATE`

Defined in: [src/ai.ts:58](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L58)


# Function: generateDialog() (/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog)



\> **generateDialog**(`request`, `options?`): `Promise`\<`string`>

Defined in: [src/ai.ts:75](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ai.ts#L75)

Generate a dialogue from a developer request, completely hiding prompt engineering.

## Parameters [#parameters]

### request [#request]

`string`

Natural language description of the dialogue to generate.

### options? [#options]

[`DialogGenerateOptions`](/pixi-vn-ai/index/interfaces/DialogGenerateOptions)

Options controlling which context gets included in the prompt.

## Returns [#returns]

`Promise`\<`string`>

The generated dialogue text.


# text (/pixi-vn-ai/index/namespaces/ai/namespaces/text)



## Functions [#functions]

* [generateDialog](/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog)


# Type Alias: CharacterItem (/pixi-vn-ai/index/type-aliases/CharacterItem)



\> **CharacterItem** = `CharacterInterface` | `CharacterIdType`

Defined in: [src/types/CharacterItem.ts:3](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/CharacterItem.ts#L3)


# Variable: AI_IMAGE_SPRITE_ID (/pixi-vn-ai/index/variables/AI_IMAGE_SPRITE_ID)



\> `const` **AI_IMAGE_SPRITE_ID**: `"AIImageSprite"` = `"AIImageSprite"`

Defined in: [src/canvas/AIImageSprite.ts:10](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/canvas/AIImageSprite.ts#L10)


# Function: createAiHandler() (/pixi-vn-ai/ink/functions/createAiHandler)



\> **createAiHandler**(`options?`): `void`

Defined in: [src/ink/aiHandler.ts:112](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ink/aiHandler.ts#L112)

Registers four Ink Hashtag-Commands that let Ink scripts drive `@drincs/pixi-vn-ai` directly:
`# ai background`, `# ai element` (both generate an image and show it as an
[AIImageSprite](/pixi-vn-ai/index/classes/AIImageSprite), with an optional entrance transition), and two forms of `# ai dialog`
(generates a line of dialogue and sets it as the current narration dialogue, with or without a
speaking character). Mirrors `@drincs/pixi-vn-spine`'s own `createSpineHandler`.

Call this once, near the start of your app (alongside e.g. `addBaseHashtagCommands`), before
any Ink content is parsed.

## Parameters [#parameters]

### options? [#options]

`CreateAiHandlerOptions` = `{}`

Optional configuration for known character ids — see
CreateAiHandlerOptions.

## Returns [#returns]

`void`

## Example [#example]

```ink
# ai background bg "The throne room, lit by torches, a storm outside the windows." style "Oil painting" with dissolve duration 1
# ai element advisor "The advisor, an elderly man with a long grey beard." align { x: 0.75, y: 1 } with dissolve duration 1
# ai dialog as advisor "Greet the king with the bad news."
```


# Function: parseAiShowTail() (/pixi-vn-ai/ink/functions/parseAiShowTail)



\> **parseAiShowTail**(`tail`): `object`

Defined in: [src/ink/aiHandler.ts:28](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/ink/aiHandler.ts#L28)

Splits the tail (everything after `<alias>`) of an `# ai background`/`# ai element` command
into its request string, free-form generate-options props, and an optional entrance
transition. Mirrors `@drincs/pixi-vn-spine`'s own `parseShowSpineTail`.

## Parameters [#parameters]

### tail [#tail]

`string`\[]

## Returns [#returns]

`object`

### propsList [#propslist]

\> **propsList**: `string`\[]

### request [#request]

\> **request**: `string` | `undefined`

### transitionPropsList [#transitionpropslist]

\> **transitionPropsList**: `string`\[]

### transitionType? [#transitiontype]

\> `optional` **transitionType?**: `"dissolve"` | `"fade"` | `"movein"` | `"zoomin"` | `"pushin"`


# ink (/pixi-vn-ai/ink)



## Functions [#functions]

* [createAiHandler](/pixi-vn-ai/ink/functions/createAiHandler)
* [parseAiShowTail](/pixi-vn-ai/ink/functions/parseAiShowTail)


# @drincs/pixi-vn-ai (/pixi-vn-ai/modules)



## Modules [#modules]

* [comfyui](/pixi-vn-ai/comfyui)
* [index](/pixi-vn-ai/index)
* [ink](/pixi-vn-ai/ink)